From cc583e14398bc78d3acb580f190028e722f6d118 Mon Sep 17 00:00:00 2001 From: aws-sdk-cpp-automation Date: Thu, 23 Apr 2020 20:38:17 +0000 Subject: [PATCH] You can now deliver streaming data to an Amazon Elasticsearch Service domain in an Amazon VPC. You can now compress streaming data delivered to S3 using Hadoop-Snappy in addition to Gzip, Zip and Snappy formats. This release supports Auto Scaling in Amazon Keyspaces for Apache Cassandra. AWS Resource Access Manager (RAM) provides a new ListResourceTypes action. This action lets you list the resource types that can be shared using AWS RAM. Added AutomaticTapeCreation APIs This release of the Amazon Pinpoint API enhances support for sending campaigns through custom channels to locations such as AWS Lambda functions or web applications. Campaigns can now use CustomDeliveryConfiguration and CampaignCustomMessage to configure custom channel settings for a campaign. Adds tagging support for PackagingGroups, PackagingConfigurations, and Assets This release adds support for transfers over FTPS and FTP in and out of Amazon S3, which makes it easy to migrate File Transfer Protocol over SSL (FTPS) and FTP workloads to AWS, in addition to the existing support for Secure File Transfer Protocol (SFTP). Adds support for AWS Local Zones, including a new optional parameter AvailabilityZoneGroup for the DescribeOrderableDBInstanceOptions operation. --- .../ApplicationAutoScalingClient.h | 451 ++++++------ .../model/CustomizedMetricSpecification.h | 16 +- .../model/DeleteScalingPolicyRequest.h | 116 ++-- .../model/DeleteScheduledActionRequest.h | 116 ++-- .../model/DeregisterScalableTargetRequest.h | 116 ++-- .../model/DescribeScalableTargetsRequest.h | 120 ++-- .../model/DescribeScalingActivitiesRequest.h | 116 ++-- .../model/DescribeScalingPoliciesRequest.h | 116 ++-- .../model/DescribeScheduledActionsRequest.h | 116 ++-- .../model/MetricType.h | 4 +- .../model/PredefinedMetricSpecification.h | 8 +- .../model/PutScalingPolicyRequest.h | 140 ++-- .../model/PutScheduledActionRequest.h | 280 +++++--- .../model/RegisterScalableTargetRequest.h | 292 ++++---- .../model/ScalableDimension.h | 4 +- .../model/ScalableTarget.h | 110 +-- .../model/ScalableTargetAction.h | 12 +- .../model/ScalingActivity.h | 110 +-- .../model/ScalingPolicy.h | 110 +-- .../model/ScheduledAction.h | 226 +++--- .../model/ServiceNamespace.h | 3 +- .../model/StepAdjustment.h | 19 +- .../model/StepScalingPolicyConfiguration.h | 196 ++++-- ...TargetTrackingScalingPolicyConfiguration.h | 116 +++- .../source/model/MetricType.cpp | 14 + .../source/model/ScalableDimension.cpp | 14 + .../source/model/ServiceNamespace.cpp | 7 + .../include/aws/awstransfer/TransferClient.h | 359 +++++----- .../awstransfer/model/CreateServerRequest.h | 491 ++++++++----- .../awstransfer/model/CreateServerResult.h | 21 +- .../aws/awstransfer/model/CreateUserRequest.h | 620 +++++++++-------- .../aws/awstransfer/model/CreateUserResult.h | 49 +- .../awstransfer/model/DeleteServerRequest.h | 24 +- .../model/DeleteSshPublicKeyRequest.h | 32 +- .../aws/awstransfer/model/DeleteUserRequest.h | 64 +- .../awstransfer/model/DescribeServerRequest.h | 24 +- .../awstransfer/model/DescribeServerResult.h | 20 +- .../awstransfer/model/DescribeUserRequest.h | 80 +-- .../awstransfer/model/DescribeUserResult.h | 28 +- .../aws/awstransfer/model/DescribedServer.h | 606 ++++++++++------ .../aws/awstransfer/model/DescribedUser.h | 536 +++++++-------- .../aws/awstransfer/model/EndpointDetails.h | 130 ++-- .../model/IdentityProviderDetails.h | 60 +- .../model/ImportSshPublicKeyRequest.h | 48 +- .../model/ImportSshPublicKeyResult.h | 50 +- .../awstransfer/model/ListServersRequest.h | 48 +- .../aws/awstransfer/model/ListServersResult.h | 28 +- .../model/ListTagsForResourceResult.h | 14 +- .../aws/awstransfer/model/ListUsersRequest.h | 32 +- .../aws/awstransfer/model/ListUsersResult.h | 28 +- .../aws/awstransfer/model/ListedServer.h | 238 ++++--- .../aws/awstransfer/model/ListedUser.h | 180 ++--- .../include/aws/awstransfer/model/Protocol.h | 42 ++ .../aws/awstransfer/model/SshPublicKey.h | 10 +- .../awstransfer/model/StartServerRequest.h | 24 +- .../aws/awstransfer/model/StopServerRequest.h | 24 +- .../include/aws/awstransfer/model/Tag.h | 24 +- .../model/TestIdentityProviderRequest.h | 109 ++- .../model/TestIdentityProviderResult.h | 14 +- .../awstransfer/model/UntagResourceRequest.h | 48 +- .../awstransfer/model/UpdateServerRequest.h | 428 ++++++++---- .../awstransfer/model/UpdateServerResult.h | 28 +- .../aws/awstransfer/model/UpdateUserRequest.h | 628 +++++++++-------- .../aws/awstransfer/model/UpdateUserResult.h | 61 +- .../source/model/CreateServerRequest.cpp | 19 + .../source/model/DescribedServer.cpp | 38 + .../source/model/Protocol.cpp | 87 +++ .../model/TestIdentityProviderRequest.cpp | 9 +- .../source/model/UpdateServerRequest.cpp | 19 + .../include/aws/core/VersionConfig.h | 2 +- .../include/aws/firehose/FirehoseClient.h | 81 ++- .../aws/firehose/model/CompressionFormat.h | 3 +- .../model/DataFormatConversionConfiguration.h | 54 +- ...liveryStreamEncryptionConfigurationInput.h | 92 ++- .../model/DeliveryStreamFailureType.h | 7 + .../ElasticsearchDestinationConfiguration.h | 35 + .../ElasticsearchDestinationDescription.h | 35 + .../firehose/model/InputFormatConfiguration.h | 3 +- .../model/OutputFormatConfiguration.h | 5 +- .../aws/firehose/model/SchemaConfiguration.h | 3 +- .../aws/firehose/model/VpcConfiguration.h | 332 +++++++++ .../model/VpcConfigurationDescription.h | 376 ++++++++++ .../source/model/CompressionFormat.cpp | 7 + .../model/DeliveryStreamFailureType.cpp | 49 ++ .../ElasticsearchDestinationConfiguration.cpp | 19 +- .../ElasticsearchDestinationDescription.cpp | 19 +- .../source/model/VpcConfiguration.cpp | 115 ++++ .../model/VpcConfigurationDescription.cpp | 130 ++++ .../mediapackage-vod/MediaPackageVodClient.h | 92 +++ .../aws/mediapackage-vod/model/AssetShallow.h | 44 ++ .../model/CreateAssetRequest.h | 44 ++ .../model/CreateAssetResult.h | 40 ++ .../CreatePackagingConfigurationRequest.h | 44 ++ .../CreatePackagingConfigurationResult.h | 40 ++ .../model/CreatePackagingGroupRequest.h | 44 ++ .../model/CreatePackagingGroupResult.h | 40 ++ .../model/DescribeAssetResult.h | 40 ++ .../DescribePackagingConfigurationResult.h | 40 ++ .../model/DescribePackagingGroupResult.h | 40 ++ .../model/ListTagsForResourceRequest.h | 77 +++ .../model/ListTagsForResourceResult.h | 89 +++ .../model/PackagingConfiguration.h | 44 ++ .../mediapackage-vod/model/PackagingGroup.h | 44 ++ .../model/TagResourceRequest.h | 121 ++++ .../model/UntagResourceRequest.h | 133 ++++ .../source/MediaPackageVodClient.cpp | 131 ++++ .../source/model/AssetShallow.cpp | 27 +- .../source/model/CreateAssetRequest.cpp | 14 +- .../source/model/CreateAssetResult.cpp | 9 + .../CreatePackagingConfigurationRequest.cpp | 14 +- .../CreatePackagingConfigurationResult.cpp | 9 + .../model/CreatePackagingGroupRequest.cpp | 14 +- .../model/CreatePackagingGroupResult.cpp | 9 + .../source/model/DescribeAssetResult.cpp | 9 + .../DescribePackagingConfigurationResult.cpp | 9 + .../model/DescribePackagingGroupResult.cpp | 9 + .../model/ListTagsForResourceRequest.cpp | 37 + .../model/ListTagsForResourceResult.cpp | 53 ++ .../source/model/PackagingConfiguration.cpp | 27 +- .../source/model/PackagingGroup.cpp | 27 +- .../source/model/TagResourceRequest.cpp | 51 ++ .../source/model/UntagResourceRequest.cpp | 55 ++ .../include/aws/pinpoint/PinpointClient.h | 36 +- .../model/ApplicationDateRangeKpiResponse.h | 16 +- .../model/ApplicationSettingsResource.h | 42 +- .../pinpoint/model/CampaignCustomMessage.h | 107 +++ .../model/CampaignDateRangeKpiResponse.h | 16 +- .../include/aws/pinpoint/model/CampaignHook.h | 68 +- .../aws/pinpoint/model/CampaignLimits.h | 57 +- .../aws/pinpoint/model/CampaignResponse.h | 129 ++-- .../aws/pinpoint/model/CampaignState.h | 42 +- .../model/CreateRecommenderConfiguration.h | 649 +++++++++--------- .../model/CustomDeliveryConfiguration.h | 203 ++++++ .../aws/pinpoint/model/EmailChannelRequest.h | 56 +- .../aws/pinpoint/model/EmailChannelResponse.h | 88 ++- .../aws/pinpoint/model/EndpointBatchItem.h | 24 +- .../aws/pinpoint/model/EndpointRequest.h | 24 +- .../model/GetApplicationDateRangeKpiRequest.h | 64 +- .../aws/pinpoint/model/GetAppsRequest.h | 16 +- .../model/GetCampaignActivitiesRequest.h | 16 +- .../model/GetCampaignDateRangeKpiRequest.h | 64 +- .../model/GetCampaignVersionsRequest.h | 16 +- .../aws/pinpoint/model/GetCampaignsRequest.h | 16 +- .../aws/pinpoint/model/GetExportJobsRequest.h | 16 +- .../aws/pinpoint/model/GetImportJobsRequest.h | 16 +- .../model/GetJourneyDateRangeKpiRequest.h | 64 +- ...etJourneyExecutionActivityMetricsRequest.h | 48 +- .../model/GetJourneyExecutionMetricsRequest.h | 48 +- .../GetRecommenderConfigurationsRequest.h | 16 +- .../model/GetSegmentExportJobsRequest.h | 16 +- .../model/GetSegmentImportJobsRequest.h | 16 +- .../model/GetSegmentVersionsRequest.h | 16 +- .../aws/pinpoint/model/GetSegmentsRequest.h | 16 +- .../model/JourneyDateRangeKpiResponse.h | 16 +- .../JourneyExecutionActivityMetricsResponse.h | 26 +- .../model/JourneyExecutionMetricsResponse.h | 26 +- .../aws/pinpoint/model/ListJourneysRequest.h | 16 +- .../model/ListTemplateVersionsRequest.h | 48 +- .../aws/pinpoint/model/ListTemplatesRequest.h | 48 +- .../aws/pinpoint/model/MessageConfiguration.h | 143 ++-- .../model/RecommenderConfigurationResponse.h | 193 +++--- .../aws/pinpoint/model/TreatmentResource.h | 75 +- .../model/UpdateRecommenderConfiguration.h | 649 +++++++++--------- .../model/WriteApplicationSettingsRequest.h | 132 ++-- .../aws/pinpoint/model/WriteCampaignRequest.h | 129 +++- .../pinpoint/model/WriteTreatmentResource.h | 75 +- .../pinpoint/model/__EndpointTypesElement.h | 50 ++ .../source/model/CampaignCustomMessage.cpp | 69 ++ .../source/model/CampaignResponse.cpp | 15 + .../model/CustomDeliveryConfiguration.cpp | 92 +++ .../source/model/MessageConfiguration.cpp | 15 + .../source/model/TreatmentResource.cpp | 15 + .../source/model/WriteCampaignRequest.cpp | 15 + .../source/model/WriteTreatmentResource.cpp | 15 + .../source/model/__EndpointTypesElement.cpp | 143 ++++ aws-cpp-sdk-ram/include/aws/ram/RAMClient.h | 34 + .../aws/ram/model/ListPrincipalsRequest.h | 120 ++-- .../aws/ram/model/ListResourceTypesRequest.h | 125 ++++ .../aws/ram/model/ListResourceTypesResult.h | 134 ++++ .../aws/ram/model/ListResourcesRequest.h | 120 ++-- .../ram/model/ServiceNameAndResourceType.h | 143 ++++ aws-cpp-sdk-ram/source/RAMClient.cpp | 36 + .../source/model/ListResourceTypesRequest.cpp | 53 ++ .../source/model/ListResourceTypesResult.cpp | 59 ++ .../model/ServiceNameAndResourceType.cpp | 84 +++ aws-cpp-sdk-rds/include/aws/rds/RDSClient.h | 54 +- ...escribeOrderableDBInstanceOptionsRequest.h | 68 ++ .../aws/rds/model/OrderableDBInstanceOption.h | 60 +- ...cribeOrderableDBInstanceOptionsRequest.cpp | 6 + .../model/OrderableDBInstanceOption.cpp | 17 + .../aws/storagegateway/StorageGatewayClient.h | 389 +++++++---- .../storagegateway/model/AddCacheRequest.h | 18 +- .../model/AddUploadBufferRequest.h | 18 +- .../model/AddWorkingStorageRequest.h | 18 +- .../model/AddWorkingStorageResult.h | 4 +- .../model/AssignTapePoolRequest.h | 32 +- .../model/AutomaticTapeCreationPolicyInfo.h | 146 ++++ .../model/AutomaticTapeCreationRule.h | 260 +++++++ .../model/CreateCachediSCSIVolumeRequest.h | 40 +- .../model/CreateNFSFileShareRequest.h | 24 +- .../model/CreateSMBFileShareRequest.h | 58 +- .../model/CreateStorediSCSIVolumeRequest.h | 24 +- .../model/CreateTapeWithBarcodeRequest.h | 80 +-- .../storagegateway/model/CreateTapesRequest.h | 80 +-- ...DeleteAutomaticTapeCreationPolicyRequest.h | 79 +++ .../DeleteAutomaticTapeCreationPolicyResult.h | 73 ++ .../model/DeleteBandwidthRateLimitResult.h | 4 +- .../storagegateway/model/DeleteVolumeResult.h | 4 +- .../model/DescribeBandwidthRateLimitRequest.h | 3 +- .../model/DescribeCacheResult.h | 22 +- .../model/DescribeCachediSCSIVolumesRequest.h | 36 +- .../DescribeMaintenanceStartTimeRequest.h | 3 +- .../model/DescribeStorediSCSIVolumesRequest.h | 36 +- .../model/DescribeTapeArchivesRequest.h | 8 +- .../model/DescribeVTLDevicesResult.h | 14 +- .../model/DescribeWorkingStorageRequest.h | 3 +- ...ListAutomaticTapeCreationPoliciesRequest.h | 79 +++ .../ListAutomaticTapeCreationPoliciesResult.h | 102 +++ .../model/ListFileSharesRequest.h | 16 +- .../model/ListLocalDisksRequest.h | 3 +- .../storagegateway/model/NFSFileShareInfo.h | 8 +- .../model/RemoveTagsFromResourceRequest.h | 18 +- .../model/ShutdownGatewayRequest.h | 4 +- .../model/ShutdownGatewayResult.h | 4 +- .../model/StartGatewayRequest.h | 4 +- .../storagegateway/model/StartGatewayResult.h | 4 +- .../model/StorageGatewayError.h | 4 +- .../include/aws/storagegateway/model/Tape.h | 32 +- .../aws/storagegateway/model/TapeInfo.h | 32 +- ...UpdateAutomaticTapeCreationPolicyRequest.h | 141 ++++ .../UpdateAutomaticTapeCreationPolicyResult.h | 73 ++ .../model/UpdateBandwidthRateLimitResult.h | 4 +- .../model/UpdateGatewaySoftwareNowRequest.h | 4 +- .../model/UpdateGatewaySoftwareNowResult.h | 4 +- .../model/UpdateMaintenanceStartTimeResult.h | 4 +- .../model/UpdateNFSFileShareRequest.h | 56 +- .../model/UpdateSMBFileShareRequest.h | 40 +- .../model/UpdateSnapshotScheduleResult.h | 4 +- .../source/StorageGatewayClient.cpp | 108 +++ .../model/AutomaticTapeCreationPolicyInfo.cpp | 92 +++ .../model/AutomaticTapeCreationRule.cpp | 118 ++++ ...leteAutomaticTapeCreationPolicyRequest.cpp | 53 ++ ...eleteAutomaticTapeCreationPolicyResult.cpp | 50 ++ ...stAutomaticTapeCreationPoliciesRequest.cpp | 53 ++ ...istAutomaticTapeCreationPoliciesResult.cpp | 53 ++ ...dateAutomaticTapeCreationPolicyRequest.cpp | 65 ++ ...pdateAutomaticTapeCreationPolicyResult.cpp | 50 ++ ...ication-autoscaling-2016-02-06.normal.json | 161 ++--- .../firehose-2015-08-04.normal.json | 186 ++++- .../mediapackage-vod-2018-11-07.normal.json | 198 ++++++ .../pinpoint-2016-12-01.normal.json | 246 ++++--- .../ram-2018-01-04.normal.json | 69 +- .../rds-2014-10-31.normal.json | 14 +- .../storagegateway-2013-06-30.normal.json | 280 ++++++-- .../transfer-2018-11-05.normal.json | 311 +++++---- 255 files changed, 14634 insertions(+), 5985 deletions(-) create mode 100644 aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Protocol.h create mode 100644 aws-cpp-sdk-awstransfer/source/model/Protocol.cpp create mode 100644 aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfiguration.h create mode 100644 aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfigurationDescription.h create mode 100644 aws-cpp-sdk-firehose/source/model/VpcConfiguration.cpp create mode 100644 aws-cpp-sdk-firehose/source/model/VpcConfigurationDescription.cpp create mode 100644 aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceRequest.h create mode 100644 aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceResult.h create mode 100644 aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/TagResourceRequest.h create mode 100644 aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/UntagResourceRequest.h create mode 100644 aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceRequest.cpp create mode 100644 aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceResult.cpp create mode 100644 aws-cpp-sdk-mediapackage-vod/source/model/TagResourceRequest.cpp create mode 100644 aws-cpp-sdk-mediapackage-vod/source/model/UntagResourceRequest.cpp create mode 100644 aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignCustomMessage.h create mode 100644 aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CustomDeliveryConfiguration.h create mode 100644 aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/__EndpointTypesElement.h create mode 100644 aws-cpp-sdk-pinpoint/source/model/CampaignCustomMessage.cpp create mode 100644 aws-cpp-sdk-pinpoint/source/model/CustomDeliveryConfiguration.cpp create mode 100644 aws-cpp-sdk-pinpoint/source/model/__EndpointTypesElement.cpp create mode 100644 aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesRequest.h create mode 100644 aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesResult.h create mode 100644 aws-cpp-sdk-ram/include/aws/ram/model/ServiceNameAndResourceType.h create mode 100644 aws-cpp-sdk-ram/source/model/ListResourceTypesRequest.cpp create mode 100644 aws-cpp-sdk-ram/source/model/ListResourceTypesResult.cpp create mode 100644 aws-cpp-sdk-ram/source/model/ServiceNameAndResourceType.cpp create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationPolicyInfo.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationRule.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyRequest.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyResult.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesRequest.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesResult.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyRequest.h create mode 100644 aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyResult.h create mode 100644 aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationPolicyInfo.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationRule.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyRequest.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyResult.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesRequest.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesResult.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyRequest.cpp create mode 100644 aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyResult.cpp diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/ApplicationAutoScalingClient.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/ApplicationAutoScalingClient.h index a1edfe7e939..1670f2fbccf 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/ApplicationAutoScalingClient.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/ApplicationAutoScalingClient.h @@ -126,22 +126,24 @@ namespace Model * Aurora Replicas

  • Amazon SageMaker endpoint variants

    • *

  • Custom resources provided by your own applications or services

    • *

  • Amazon Comprehend document classification endpoints

  • - *

    AWS Lambda function provisioned concurrency

    • API - * Summary

    The Application Auto Scaling service API includes three key - * sets of actions:

    To learn more about Application Auto Scaling, - * including information about granting IAM users required permissions for + *

    AWS Lambda function provisioned concurrency

  • Amazon + * Keyspaces for Apache Cassandra tables

    • API Summary + *

    The Application Auto Scaling service API includes three key sets of + * actions:

    To learn more about Application Auto + * Scaling, including information about granting IAM users required permissions for * Application Auto Scaling actions, see the Application * Auto Scaling User Guide.

    @@ -185,8 +187,7 @@ namespace Model * a Step Scaling Policy and Delete * a Target Tracking Scaling Policy in the Application Auto Scaling User - * Guide.

    To create a scaling policy or update an existing one, see - * PutScalingPolicy.

    See Also:

    .

    See Also:

    AWS * API Reference

    */ @@ -202,8 +203,7 @@ namespace Model * a Step Scaling Policy and Delete * a Target Tracking Scaling Policy in the Application Auto Scaling User - * Guide.

    To create a scaling policy or update an existing one, see - * PutScalingPolicy.

    See Also:

    .

    See Also:

    AWS * API Reference

    * @@ -221,8 +221,7 @@ namespace Model * a Step Scaling Policy and Delete * a Target Tracking Scaling Policy in the Application Auto Scaling User - * Guide.

    To create a scaling policy or update an existing one, see - * PutScalingPolicy.

    See Also:

    .

    See Also:

    AWS * API Reference

    * @@ -268,20 +267,24 @@ namespace Model virtual void DeleteScheduledActionAsync(const Model::DeleteScheduledActionRequest& request, const DeleteScheduledActionResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Deregisters an Application Auto Scaling scalable target.

    Deregistering - * a scalable target deletes the scaling policies that are associated with it.

    - *

    To create a scalable target or update an existing one, see - * RegisterScalableTarget.

    See Also:

    Deregisters an Application Auto Scaling scalable target when you have + * finished using it. To see which resources have been registered, use DescribeScalableTargets. + *

    Deregistering a scalable target deletes the scaling policies and + * the scheduled actions that are associated with it.

    See + * Also:

    AWS * API Reference

    */ virtual Model::DeregisterScalableTargetOutcome DeregisterScalableTarget(const Model::DeregisterScalableTargetRequest& request) const; /** - *

    Deregisters an Application Auto Scaling scalable target.

    Deregistering - * a scalable target deletes the scaling policies that are associated with it.

    - *

    To create a scalable target or update an existing one, see - * RegisterScalableTarget.

    See Also:

    Deregisters an Application Auto Scaling scalable target when you have + * finished using it. To see which resources have been registered, use DescribeScalableTargets. + *

    Deregistering a scalable target deletes the scaling policies and + * the scheduled actions that are associated with it.

    See + * Also:

    AWS * API Reference

    * @@ -290,10 +293,12 @@ namespace Model virtual Model::DeregisterScalableTargetOutcomeCallable DeregisterScalableTargetCallable(const Model::DeregisterScalableTargetRequest& request) const; /** - *

    Deregisters an Application Auto Scaling scalable target.

    Deregistering - * a scalable target deletes the scaling policies that are associated with it.

    - *

    To create a scalable target or update an existing one, see - * RegisterScalableTarget.

    See Also:

    Deregisters an Application Auto Scaling scalable target when you have + * finished using it. To see which resources have been registered, use DescribeScalableTargets. + *

    Deregistering a scalable target deletes the scaling policies and + * the scheduled actions that are associated with it.

    See + * Also:

    AWS * API Reference

    * @@ -304,10 +309,7 @@ namespace Model /** *

    Gets information about the scalable targets in the specified namespace.

    *

    You can filter the results using ResourceIds and - * ScalableDimension.

    To create a scalable target or update an - * existing one, see RegisterScalableTarget. If you are no longer using a - * scalable target, you can deregister it using - * DeregisterScalableTarget.

    See Also:

    ScalableDimension.

    See Also:

    AWS * API Reference

    */ @@ -316,10 +318,7 @@ namespace Model /** *

    Gets information about the scalable targets in the specified namespace.

    *

    You can filter the results using ResourceIds and - * ScalableDimension.

    To create a scalable target or update an - * existing one, see RegisterScalableTarget. If you are no longer using a - * scalable target, you can deregister it using - * DeregisterScalableTarget.

    See Also:

    ScalableDimension.

    See Also:

    AWS * API Reference

    * @@ -330,10 +329,7 @@ namespace Model /** *

    Gets information about the scalable targets in the specified namespace.

    *

    You can filter the results using ResourceIds and - * ScalableDimension.

    To create a scalable target or update an - * existing one, see RegisterScalableTarget. If you are no longer using a - * scalable target, you can deregister it using - * DeregisterScalableTarget.

    See Also:

    ScalableDimension.

    See Also:

    AWS * API Reference

    * @@ -344,11 +340,8 @@ namespace Model /** *

    Provides descriptive information about the scaling activities in the * specified namespace from the previous six weeks.

    You can filter the - * results using ResourceId and ScalableDimension.

    - *

    Scaling activities are triggered by CloudWatch alarms that are associated - * with scaling policies. To view the scaling policies for a service namespace, see - * DescribeScalingPolicies. To create a scaling policy or update an existing - * one, see PutScalingPolicy.

    See Also:

    ResourceId and + * ScalableDimension.

    See Also:

    AWS * API Reference

    */ @@ -357,11 +350,8 @@ namespace Model /** *

    Provides descriptive information about the scaling activities in the * specified namespace from the previous six weeks.

    You can filter the - * results using ResourceId and ScalableDimension.

    - *

    Scaling activities are triggered by CloudWatch alarms that are associated - * with scaling policies. To view the scaling policies for a service namespace, see - * DescribeScalingPolicies. To create a scaling policy or update an existing - * one, see PutScalingPolicy.

    See Also:

    ResourceId and + * ScalableDimension.

    See Also:

    AWS * API Reference

    * @@ -372,11 +362,8 @@ namespace Model /** *

    Provides descriptive information about the scaling activities in the * specified namespace from the previous six weeks.

    You can filter the - * results using ResourceId and ScalableDimension.

    - *

    Scaling activities are triggered by CloudWatch alarms that are associated - * with scaling policies. To view the scaling policies for a service namespace, see - * DescribeScalingPolicies. To create a scaling policy or update an existing - * one, see PutScalingPolicy.

    See Also:

    ResourceId and + * ScalableDimension.

    See Also:

    AWS * API Reference

    * @@ -388,10 +375,12 @@ namespace Model *

    Describes the Application Auto Scaling scaling policies for the specified * service namespace.

    You can filter the results using * ResourceId, ScalableDimension, and - * PolicyNames.

    To create a scaling policy or update an - * existing one, see PutScalingPolicy. If you are no longer using a scaling - * policy, you can delete it using DeleteScalingPolicy.

    See - * Also:

    PolicyNames.

    For more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User + * Guide.

    See Also:

    AWS * API Reference

    */ @@ -401,10 +390,12 @@ namespace Model *

    Describes the Application Auto Scaling scaling policies for the specified * service namespace.

    You can filter the results using * ResourceId, ScalableDimension, and - * PolicyNames.

    To create a scaling policy or update an - * existing one, see PutScalingPolicy. If you are no longer using a scaling - * policy, you can delete it using DeleteScalingPolicy.

    See - * Also:

    PolicyNames.

    For more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User + * Guide.

    See Also:

    AWS * API Reference

    * @@ -416,10 +407,12 @@ namespace Model *

    Describes the Application Auto Scaling scaling policies for the specified * service namespace.

    You can filter the results using * ResourceId, ScalableDimension, and - * PolicyNames.

    To create a scaling policy or update an - * existing one, see PutScalingPolicy. If you are no longer using a scaling - * policy, you can delete it using DeleteScalingPolicy.

    See - * Also:

    PolicyNames.

    For more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User + * Guide.

    See Also:

    AWS * API Reference

    * @@ -431,10 +424,11 @@ namespace Model *

    Describes the Application Auto Scaling scheduled actions for the specified * service namespace.

    You can filter the results using the * ResourceId, ScalableDimension, and - * ScheduledActionNames parameters.

    To create a scheduled - * action or update an existing one, see PutScheduledAction. If you are no - * longer using a scheduled action, you can delete it using - * DeleteScheduledAction.

    See Also:

    ScheduledActionNames parameters.

    For more information, see + * Scheduled + * Scaling in the Application Auto Scaling User Guide.

    See + * Also:

    AWS * API Reference

    */ @@ -444,10 +438,11 @@ namespace Model *

    Describes the Application Auto Scaling scheduled actions for the specified * service namespace.

    You can filter the results using the * ResourceId, ScalableDimension, and - * ScheduledActionNames parameters.

    To create a scheduled - * action or update an existing one, see PutScheduledAction. If you are no - * longer using a scheduled action, you can delete it using - * DeleteScheduledAction.

    See Also:

    ScheduledActionNames parameters.

    For more information, see + * Scheduled + * Scaling in the Application Auto Scaling User Guide.

    See + * Also:

    AWS * API Reference

    * @@ -459,10 +454,11 @@ namespace Model *

    Describes the Application Auto Scaling scheduled actions for the specified * service namespace.

    You can filter the results using the * ResourceId, ScalableDimension, and - * ScheduledActionNames parameters.

    To create a scheduled - * action or update an existing one, see PutScheduledAction. If you are no - * longer using a scheduled action, you can delete it using - * DeleteScheduledAction.

    See Also:

    ScheduledActionNames parameters.

    For more information, see + * Scheduled + * Scaling in the Application Auto Scaling User Guide.

    See + * Also:

    AWS * API Reference

    * @@ -471,58 +467,56 @@ namespace Model virtual void DescribeScheduledActionsAsync(const Model::DescribeScheduledActionsRequest& request, const DescribeScheduledActionsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Creates or updates a policy for an Application Auto Scaling scalable + *

    Creates or updates a scaling policy for an Application Auto Scaling scalable * target.

    Each scalable target is identified by a service namespace, * resource ID, and scalable dimension. A scaling policy applies to the scalable * target identified by those three attributes. You cannot create a scaling policy - * until you have registered the resource as a scalable target using - * RegisterScalableTarget.

    To update a policy, specify its policy - * name and the parameters that you want to change. Any parameters that you don't - * specify are not changed by this update request.

    You can view the scaling - * policies for a service namespace using DescribeScalingPolicies. If you - * are no longer using a scaling policy, you can delete it using - * DeleteScalingPolicy.

    Multiple scaling policies can be in force at - * the same time for the same scalable target. You can have one or more target - * tracking scaling policies, one or more step scaling policies, or both. However, - * there is a chance that multiple policies could conflict, instructing the - * scalable target to scale out or in at the same time. Application Auto Scaling - * gives precedence to the policy that provides the largest capacity for both scale - * out and scale in. For example, if one policy increases capacity by 3, another - * policy increases capacity by 200 percent, and the current capacity is 10, - * Application Auto Scaling uses the policy with the highest calculated capacity - * (200% of 10 = 20) and scales out to 30.

    Learn more about how to work - * with scaling policies in the Application - * Auto Scaling User Guide.

    See Also:

    Multiple + * scaling policies can be in force at the same time for the same scalable target. + * You can have one or more target tracking scaling policies, one or more step + * scaling policies, or both. However, there is a chance that multiple policies + * could conflict, instructing the scalable target to scale out or in at the same + * time. Application Auto Scaling gives precedence to the policy that provides the + * largest capacity for both scale out and scale in. For example, if one policy + * increases capacity by 3, another policy increases capacity by 200 percent, and + * the current capacity is 10, Application Auto Scaling uses the policy with the + * highest calculated capacity (200% of 10 = 20) and scales out to 30.

    For + * more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User Guide.

    + *

    If a scalable target is deregistered, the scalable target is no longer + * available to execute scaling policies. Any scaling policies that were specified + * for the scalable target are deleted.

    See Also:

    AWS * API Reference

    */ virtual Model::PutScalingPolicyOutcome PutScalingPolicy(const Model::PutScalingPolicyRequest& request) const; /** - *

    Creates or updates a policy for an Application Auto Scaling scalable + *

    Creates or updates a scaling policy for an Application Auto Scaling scalable * target.

    Each scalable target is identified by a service namespace, * resource ID, and scalable dimension. A scaling policy applies to the scalable * target identified by those three attributes. You cannot create a scaling policy - * until you have registered the resource as a scalable target using - * RegisterScalableTarget.

    To update a policy, specify its policy - * name and the parameters that you want to change. Any parameters that you don't - * specify are not changed by this update request.

    You can view the scaling - * policies for a service namespace using DescribeScalingPolicies. If you - * are no longer using a scaling policy, you can delete it using - * DeleteScalingPolicy.

    Multiple scaling policies can be in force at - * the same time for the same scalable target. You can have one or more target - * tracking scaling policies, one or more step scaling policies, or both. However, - * there is a chance that multiple policies could conflict, instructing the - * scalable target to scale out or in at the same time. Application Auto Scaling - * gives precedence to the policy that provides the largest capacity for both scale - * out and scale in. For example, if one policy increases capacity by 3, another - * policy increases capacity by 200 percent, and the current capacity is 10, - * Application Auto Scaling uses the policy with the highest calculated capacity - * (200% of 10 = 20) and scales out to 30.

    Learn more about how to work - * with scaling policies in the Application - * Auto Scaling User Guide.

    See Also:

    Multiple + * scaling policies can be in force at the same time for the same scalable target. + * You can have one or more target tracking scaling policies, one or more step + * scaling policies, or both. However, there is a chance that multiple policies + * could conflict, instructing the scalable target to scale out or in at the same + * time. Application Auto Scaling gives precedence to the policy that provides the + * largest capacity for both scale out and scale in. For example, if one policy + * increases capacity by 3, another policy increases capacity by 200 percent, and + * the current capacity is 10, Application Auto Scaling uses the policy with the + * highest calculated capacity (200% of 10 = 20) and scales out to 30.

    For + * more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User Guide.

    + *

    If a scalable target is deregistered, the scalable target is no longer + * available to execute scaling policies. Any scaling policies that were specified + * for the scalable target are deleted.

    See Also:

    AWS * API Reference

    * @@ -531,29 +525,28 @@ namespace Model virtual Model::PutScalingPolicyOutcomeCallable PutScalingPolicyCallable(const Model::PutScalingPolicyRequest& request) const; /** - *

    Creates or updates a policy for an Application Auto Scaling scalable + *

    Creates or updates a scaling policy for an Application Auto Scaling scalable * target.

    Each scalable target is identified by a service namespace, * resource ID, and scalable dimension. A scaling policy applies to the scalable * target identified by those three attributes. You cannot create a scaling policy - * until you have registered the resource as a scalable target using - * RegisterScalableTarget.

    To update a policy, specify its policy - * name and the parameters that you want to change. Any parameters that you don't - * specify are not changed by this update request.

    You can view the scaling - * policies for a service namespace using DescribeScalingPolicies. If you - * are no longer using a scaling policy, you can delete it using - * DeleteScalingPolicy.

    Multiple scaling policies can be in force at - * the same time for the same scalable target. You can have one or more target - * tracking scaling policies, one or more step scaling policies, or both. However, - * there is a chance that multiple policies could conflict, instructing the - * scalable target to scale out or in at the same time. Application Auto Scaling - * gives precedence to the policy that provides the largest capacity for both scale - * out and scale in. For example, if one policy increases capacity by 3, another - * policy increases capacity by 200 percent, and the current capacity is 10, - * Application Auto Scaling uses the policy with the highest calculated capacity - * (200% of 10 = 20) and scales out to 30.

    Learn more about how to work - * with scaling policies in the Application - * Auto Scaling User Guide.

    See Also:

    Multiple + * scaling policies can be in force at the same time for the same scalable target. + * You can have one or more target tracking scaling policies, one or more step + * scaling policies, or both. However, there is a chance that multiple policies + * could conflict, instructing the scalable target to scale out or in at the same + * time. Application Auto Scaling gives precedence to the policy that provides the + * largest capacity for both scale out and scale in. For example, if one policy + * increases capacity by 3, another policy increases capacity by 200 percent, and + * the current capacity is 10, Application Auto Scaling uses the policy with the + * highest calculated capacity (200% of 10 = 20) and scales out to 30.

    For + * more information, see Target + * Tracking Scaling Policies and Step + * Scaling Policies in the Application Auto Scaling User Guide.

    + *

    If a scalable target is deregistered, the scalable target is no longer + * available to execute scaling policies. Any scaling policies that were specified + * for the scalable target are deleted.

    See Also:

    AWS * API Reference

    * @@ -566,17 +559,17 @@ namespace Model * scalable target.

    Each scalable target is identified by a service * namespace, resource ID, and scalable dimension. A scheduled action applies to * the scalable target identified by those three attributes. You cannot create a - * scheduled action until you have registered the resource as a scalable target - * using RegisterScalableTarget.

    To update an action, specify its - * name and the parameters that you want to change. If you don't specify start and - * end times, the old values are deleted. Any other parameters that you don't - * specify are not changed by this update request.

    You can view the - * scheduled actions using DescribeScheduledActions. If you are no longer - * using a scheduled action, you can delete it using - * DeleteScheduledAction.

    Learn more about how to work with scheduled - * actions in the Application - * Auto Scaling User Guide.

    See Also:

    When start and end times are specified with a recurring schedule + * using a cron expression or rates, they form the boundaries of when the recurring + * action starts and stops.

    To update a scheduled action, specify the + * parameters that you want to change. If you don't specify start and end times, + * the old values are deleted.

    For more information, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    If + * a scalable target is deregistered, the scalable target is no longer available to + * run scheduled actions. Any scheduled actions that were specified for the + * scalable target are deleted.

    See Also:

    AWS * API Reference

    */ @@ -587,17 +580,17 @@ namespace Model * scalable target.

    Each scalable target is identified by a service * namespace, resource ID, and scalable dimension. A scheduled action applies to * the scalable target identified by those three attributes. You cannot create a - * scheduled action until you have registered the resource as a scalable target - * using RegisterScalableTarget.

    To update an action, specify its - * name and the parameters that you want to change. If you don't specify start and - * end times, the old values are deleted. Any other parameters that you don't - * specify are not changed by this update request.

    You can view the - * scheduled actions using DescribeScheduledActions. If you are no longer - * using a scheduled action, you can delete it using - * DeleteScheduledAction.

    Learn more about how to work with scheduled - * actions in the Application - * Auto Scaling User Guide.

    See Also:

    When start and end times are specified with a recurring schedule + * using a cron expression or rates, they form the boundaries of when the recurring + * action starts and stops.

    To update a scheduled action, specify the + * parameters that you want to change. If you don't specify start and end times, + * the old values are deleted.

    For more information, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    If + * a scalable target is deregistered, the scalable target is no longer available to + * run scheduled actions. Any scheduled actions that were specified for the + * scalable target are deleted.

    See Also:

    AWS * API Reference

    * @@ -610,17 +603,17 @@ namespace Model * scalable target.

    Each scalable target is identified by a service * namespace, resource ID, and scalable dimension. A scheduled action applies to * the scalable target identified by those three attributes. You cannot create a - * scheduled action until you have registered the resource as a scalable target - * using RegisterScalableTarget.

    To update an action, specify its - * name and the parameters that you want to change. If you don't specify start and - * end times, the old values are deleted. Any other parameters that you don't - * specify are not changed by this update request.

    You can view the - * scheduled actions using DescribeScheduledActions. If you are no longer - * using a scheduled action, you can delete it using - * DeleteScheduledAction.

    Learn more about how to work with scheduled - * actions in the Application - * Auto Scaling User Guide.

    See Also:

    When start and end times are specified with a recurring schedule + * using a cron expression or rates, they form the boundaries of when the recurring + * action starts and stops.

    To update a scheduled action, specify the + * parameters that you want to change. If you don't specify start and end times, + * the old values are deleted.

    For more information, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    If + * a scalable target is deregistered, the scalable target is no longer available to + * run scheduled actions. Any scheduled actions that were specified for the + * scalable target are deleted.

    See Also:

    AWS * API Reference

    * @@ -629,44 +622,48 @@ namespace Model virtual void PutScheduledActionAsync(const Model::PutScheduledActionRequest& request, const PutScheduledActionResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Registers or updates a scalable target. A scalable target is a resource that - * Application Auto Scaling can scale out and scale in. Scalable targets are - * uniquely identified by the combination of resource ID, scalable dimension, and - * namespace.

    When you register a new scalable target, you must specify - * values for minimum and maximum capacity. Application Auto Scaling will not scale - * capacity to values that are outside of this range.

    To update a scalable - * target, specify the parameter that you want to change as well as the following - * parameters that identify the scalable target: resource ID, scalable dimension, - * and namespace. Any parameters that you don't specify are not changed by this - * update request.

    After you register a scalable target, you do not need to - * register it again to use other Application Auto Scaling operations. To see which - * resources have been registered, use DescribeScalableTargets. You can also - * view the scaling policies for a service namespace by using - * DescribeScalableTargets.

    If you no longer need a scalable target, - * you can deregister it by using DeregisterScalableTarget.

    See - * Also:

    Registers or updates a scalable target.

    A scalable target is a + * resource that Application Auto Scaling can scale out and scale in. Scalable + * targets are uniquely identified by the combination of resource ID, scalable + * dimension, and namespace.

    When you register a new scalable target, you + * must specify values for minimum and maximum capacity. Application Auto Scaling + * scaling policies will not scale capacity to values that are outside of this + * range.

    After you register a scalable target, you do not need to register + * it again to use other Application Auto Scaling operations. To see which + * resources have been registered, use DescribeScalableTargets. + * You can also view the scaling policies for a service namespace by using DescribeScalableTargets. + * If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

    + *

    To update a scalable target, specify the parameters that you want to change. + * Include the parameters that identify the scalable target: resource ID, scalable + * dimension, and namespace. Any parameters that you don't specify are not changed + * by this update request.

    See Also:

    AWS * API Reference

    */ virtual Model::RegisterScalableTargetOutcome RegisterScalableTarget(const Model::RegisterScalableTargetRequest& request) const; /** - *

    Registers or updates a scalable target. A scalable target is a resource that - * Application Auto Scaling can scale out and scale in. Scalable targets are - * uniquely identified by the combination of resource ID, scalable dimension, and - * namespace.

    When you register a new scalable target, you must specify - * values for minimum and maximum capacity. Application Auto Scaling will not scale - * capacity to values that are outside of this range.

    To update a scalable - * target, specify the parameter that you want to change as well as the following - * parameters that identify the scalable target: resource ID, scalable dimension, - * and namespace. Any parameters that you don't specify are not changed by this - * update request.

    After you register a scalable target, you do not need to - * register it again to use other Application Auto Scaling operations. To see which - * resources have been registered, use DescribeScalableTargets. You can also - * view the scaling policies for a service namespace by using - * DescribeScalableTargets.

    If you no longer need a scalable target, - * you can deregister it by using DeregisterScalableTarget.

    See - * Also:

    Registers or updates a scalable target.

    A scalable target is a + * resource that Application Auto Scaling can scale out and scale in. Scalable + * targets are uniquely identified by the combination of resource ID, scalable + * dimension, and namespace.

    When you register a new scalable target, you + * must specify values for minimum and maximum capacity. Application Auto Scaling + * scaling policies will not scale capacity to values that are outside of this + * range.

    After you register a scalable target, you do not need to register + * it again to use other Application Auto Scaling operations. To see which + * resources have been registered, use DescribeScalableTargets. + * You can also view the scaling policies for a service namespace by using DescribeScalableTargets. + * If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

    + *

    To update a scalable target, specify the parameters that you want to change. + * Include the parameters that identify the scalable target: resource ID, scalable + * dimension, and namespace. Any parameters that you don't specify are not changed + * by this update request.

    See Also:

    AWS * API Reference

    * @@ -675,22 +672,24 @@ namespace Model virtual Model::RegisterScalableTargetOutcomeCallable RegisterScalableTargetCallable(const Model::RegisterScalableTargetRequest& request) const; /** - *

    Registers or updates a scalable target. A scalable target is a resource that - * Application Auto Scaling can scale out and scale in. Scalable targets are - * uniquely identified by the combination of resource ID, scalable dimension, and - * namespace.

    When you register a new scalable target, you must specify - * values for minimum and maximum capacity. Application Auto Scaling will not scale - * capacity to values that are outside of this range.

    To update a scalable - * target, specify the parameter that you want to change as well as the following - * parameters that identify the scalable target: resource ID, scalable dimension, - * and namespace. Any parameters that you don't specify are not changed by this - * update request.

    After you register a scalable target, you do not need to - * register it again to use other Application Auto Scaling operations. To see which - * resources have been registered, use DescribeScalableTargets. You can also - * view the scaling policies for a service namespace by using - * DescribeScalableTargets.

    If you no longer need a scalable target, - * you can deregister it by using DeregisterScalableTarget.

    See - * Also:

    Registers or updates a scalable target.

    A scalable target is a + * resource that Application Auto Scaling can scale out and scale in. Scalable + * targets are uniquely identified by the combination of resource ID, scalable + * dimension, and namespace.

    When you register a new scalable target, you + * must specify values for minimum and maximum capacity. Application Auto Scaling + * scaling policies will not scale capacity to values that are outside of this + * range.

    After you register a scalable target, you do not need to register + * it again to use other Application Auto Scaling operations. To see which + * resources have been registered, use DescribeScalableTargets. + * You can also view the scaling policies for a service namespace by using DescribeScalableTargets. + * If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

    + *

    To update a scalable target, specify the parameters that you want to change. + * Include the parameters that identify the scalable target: resource ID, scalable + * dimension, and namespace. Any parameters that you don't specify are not changed + * by this update request.

    See Also:

    AWS * API Reference

    * diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/CustomizedMetricSpecification.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/CustomizedMetricSpecification.h index 7f69b7709ab..a35bd67960b 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/CustomizedMetricSpecification.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/CustomizedMetricSpecification.h @@ -38,17 +38,21 @@ namespace Model /** *

    Represents a CloudWatch metric of your choosing for a target tracking scaling - * policy to use with Application Auto Scaling.

    To create your customized - * metric specification:

    • Add values for each required parameter - * from CloudWatch. You can use an existing metric, or a new metric that you - * create. To use your own metric, you must first publish the metric to CloudWatch. - * For more information, see

      For information about the + * available metrics for a service, see AWS + * Services That Publish CloudWatch Metrics in the Amazon CloudWatch User + * Guide.

      To create your customized metric specification:

      • + *

        Add values for each required parameter from CloudWatch. You can use an + * existing metric, or a new metric that you create. To use your own metric, you + * must first publish the metric to CloudWatch. For more information, see Publish * Custom Metrics in the Amazon CloudWatch User Guide.

      • *

        Choose a metric that changes proportionally with capacity. The value of the * metric should increase or decrease in inverse proportion to the number of * capacity units. That is, the value of the metric should decrease when capacity - * increases.

      For more information about CloudWatch, see

    For more + * information about CloudWatch, see Amazon * CloudWatch Concepts.

    See Also:

    AWS diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScalingPolicyRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScalingPolicyRequest.h index 2a35e250bb5..be469102c7a 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScalingPolicyRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScalingPolicyRequest.h @@ -88,56 +88,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeleteScalingPolicyRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeleteScalingPolicyRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -179,7 +167,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -220,7 +210,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -261,7 +253,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -302,7 +296,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -343,7 +339,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -384,7 +382,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScalingPolicyRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -425,7 +425,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScalingPolicyRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -466,7 +468,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScalingPolicyRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -499,7 +503,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -531,7 +539,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -563,7 +575,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -595,7 +611,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -627,7 +647,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeleteScalingPolicyRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -659,7 +683,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeleteScalingPolicyRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScheduledActionRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScheduledActionRequest.h index e47c7f24b95..44eac9523d6 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScheduledActionRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeleteScheduledActionRequest.h @@ -47,56 +47,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeleteScheduledActionRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeleteScheduledActionRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -179,7 +167,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -220,7 +210,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -261,7 +253,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -302,7 +296,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -343,7 +339,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -384,7 +382,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScheduledActionRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -425,7 +425,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScheduledActionRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -466,7 +468,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeleteScheduledActionRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -499,7 +503,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -531,7 +539,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -563,7 +575,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -595,7 +611,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -627,7 +647,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeleteScheduledActionRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -659,7 +683,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeleteScheduledActionRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeregisterScalableTargetRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeregisterScalableTargetRequest.h index afcdaee7385..ab13c3abcea 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeregisterScalableTargetRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DeregisterScalableTargetRequest.h @@ -47,56 +47,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeregisterScalableTargetRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DeregisterScalableTargetRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -138,7 +126,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -179,7 +169,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -220,7 +212,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -261,7 +255,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -302,7 +298,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -343,7 +341,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeregisterScalableTargetRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -384,7 +384,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeregisterScalableTargetRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -425,7 +427,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DeregisterScalableTargetRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -459,7 +463,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -492,7 +500,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -525,7 +537,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -558,7 +574,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -591,7 +611,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeregisterScalableTargetRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -624,7 +648,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DeregisterScalableTargetRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalableTargetsRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalableTargetsRequest.h index 39f18ebb622..0e776b11934 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalableTargetsRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalableTargetsRequest.h @@ -48,56 +48,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalableTargetsRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalableTargetsRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -140,7 +128,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::Vector& GetResourceIds() const{ return m_resourceIds; } @@ -182,7 +172,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdsHasBeenSet() const { return m_resourceIdsHasBeenSet; } @@ -224,7 +216,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceIds(const Aws::Vector& value) { m_resourceIdsHasBeenSet = true; m_resourceIds = value; } @@ -266,7 +260,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceIds(Aws::Vector&& value) { m_resourceIdsHasBeenSet = true; m_resourceIds = std::move(value); } @@ -308,7 +304,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalableTargetsRequest& WithResourceIds(const Aws::Vector& value) { SetResourceIds(value); return *this;} @@ -350,7 +348,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalableTargetsRequest& WithResourceIds(Aws::Vector&& value) { SetResourceIds(std::move(value)); return *this;} @@ -392,7 +392,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalableTargetsRequest& AddResourceIds(const Aws::String& value) { m_resourceIdsHasBeenSet = true; m_resourceIds.push_back(value); return *this; } @@ -434,7 +436,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalableTargetsRequest& AddResourceIds(Aws::String&& value) { m_resourceIdsHasBeenSet = true; m_resourceIds.push_back(std::move(value)); return *this; } @@ -476,7 +480,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalableTargetsRequest& AddResourceIds(const char* value) { m_resourceIdsHasBeenSet = true; m_resourceIds.push_back(value); return *this; } @@ -510,7 +516,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -543,7 +553,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -576,7 +590,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -609,7 +627,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -642,7 +664,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalableTargetsRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -675,7 +701,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalableTargetsRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingActivitiesRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingActivitiesRequest.h index 528189c735d..db4074d1d51 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingActivitiesRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingActivitiesRequest.h @@ -47,56 +47,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalingActivitiesRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalingActivitiesRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -139,7 +127,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -181,7 +171,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -223,7 +215,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -265,7 +259,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -307,7 +303,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -349,7 +347,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingActivitiesRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -391,7 +391,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingActivitiesRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -433,7 +435,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingActivitiesRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -467,7 +471,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -500,7 +508,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -533,7 +545,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -566,7 +582,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -599,7 +619,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalingActivitiesRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -632,7 +656,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalingActivitiesRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingPoliciesRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingPoliciesRequest.h index 3225ab43d1f..1be13a43b1d 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingPoliciesRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScalingPoliciesRequest.h @@ -94,56 +94,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalingPoliciesRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScalingPoliciesRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -186,7 +174,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -228,7 +218,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -270,7 +262,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -312,7 +306,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -354,7 +350,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -396,7 +394,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingPoliciesRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -438,7 +438,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingPoliciesRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -480,7 +482,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScalingPoliciesRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -514,7 +518,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -547,7 +555,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -580,7 +592,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -613,7 +629,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -646,7 +666,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalingPoliciesRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -679,7 +703,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScalingPoliciesRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScheduledActionsRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScheduledActionsRequest.h index 43a320acd5c..9e282b6c780 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScheduledActionsRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/DescribeScheduledActionsRequest.h @@ -94,56 +94,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScheduledActionsRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline DescribeScheduledActionsRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -186,7 +174,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -228,7 +218,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -270,7 +262,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -312,7 +306,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -354,7 +350,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -396,7 +394,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScheduledActionsRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -438,7 +438,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScheduledActionsRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -480,7 +482,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline DescribeScheduledActionsRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -514,7 +518,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -547,7 +555,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -580,7 +592,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -613,7 +629,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -646,7 +666,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScheduledActionsRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -679,7 +703,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline DescribeScheduledActionsRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/MetricType.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/MetricType.h index a73b9f01ea2..30d0d6008d4 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/MetricType.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/MetricType.h @@ -39,7 +39,9 @@ namespace Model ECSServiceAverageMemoryUtilization, AppStreamAverageCapacityUtilization, ComprehendInferenceUtilization, - LambdaProvisionedConcurrencyUtilization + LambdaProvisionedConcurrencyUtilization, + CassandraReadCapacityUtilization, + CassandraWriteCapacityUtilization }; namespace MetricTypeMapper diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PredefinedMetricSpecification.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PredefinedMetricSpecification.h index b59ac218acb..fb5b2cf146c 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PredefinedMetricSpecification.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PredefinedMetricSpecification.h @@ -36,7 +36,13 @@ namespace Model /** *

    Represents a predefined metric for a target tracking scaling policy to use - * with Application Auto Scaling.

    See Also:

    Only the AWS services that you're using + * send metrics to Amazon CloudWatch. To determine whether a desired metric already + * exists by looking up its namespace and dimension using the CloudWatch metrics + * dashboard in the console, follow the procedure in Building + * Dashboards with CloudWatch in the Application Auto Scaling User + * Guide.

    See Also:

    AWS * API Reference

    */ diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScalingPolicyRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScalingPolicyRequest.h index 98f16f7bcee..2f99d0a2d4b 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScalingPolicyRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScalingPolicyRequest.h @@ -91,56 +91,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline PutScalingPolicyRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline PutScalingPolicyRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -182,7 +170,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -223,7 +213,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -264,7 +256,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -305,7 +299,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -346,7 +342,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -387,7 +385,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScalingPolicyRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -428,7 +428,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScalingPolicyRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -469,7 +471,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScalingPolicyRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -502,7 +506,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -534,7 +542,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -566,7 +578,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -598,7 +614,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -630,7 +650,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline PutScalingPolicyRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -662,7 +686,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline PutScalingPolicyRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} @@ -671,8 +699,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step @@ -684,8 +712,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step @@ -697,8 +725,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step @@ -710,8 +738,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step @@ -723,8 +751,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step @@ -736,8 +764,8 @@ namespace Model *

    The policy type. This parameter is required if you are creating a scaling * policy.

    The following policy types are supported:

    * TargetTrackingScaling—Not supported for Amazon EMR

    - * StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS - * Lambda

    For more information, see StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, + * or Amazon Keyspaces for Apache Cassandra.

    For more information, see Target * Tracking Scaling Policies and Step diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScheduledActionRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScheduledActionRequest.h index 42e131ab164..479abab23ec 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScheduledActionRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/PutScheduledActionRequest.h @@ -49,56 +49,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline PutScheduledActionRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline PutScheduledActionRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -110,12 +98,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline const Aws::String& GetSchedule() const{ return m_schedule; } @@ -126,12 +117,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; } @@ -142,12 +136,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(const Aws::String& value) { m_scheduleHasBeenSet = true; m_schedule = value; } @@ -158,12 +155,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(Aws::String&& value) { m_scheduleHasBeenSet = true; m_schedule = std::move(value); } @@ -174,12 +174,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(const char* value) { m_scheduleHasBeenSet = true; m_schedule.assign(value); } @@ -190,12 +193,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline PutScheduledActionRequest& WithSchedule(const Aws::String& value) { SetSchedule(value); return *this;} @@ -206,12 +212,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline PutScheduledActionRequest& WithSchedule(Aws::String&& value) { SetSchedule(std::move(value)); return *this;} @@ -222,53 +231,64 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline PutScheduledActionRequest& WithSchedule(const char* value) { SetSchedule(value); return *this;} /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline const Aws::String& GetScheduledActionName() const{ return m_scheduledActionName; } /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline bool ScheduledActionNameHasBeenSet() const { return m_scheduledActionNameHasBeenSet; } /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline void SetScheduledActionName(const Aws::String& value) { m_scheduledActionNameHasBeenSet = true; m_scheduledActionName = value; } /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline void SetScheduledActionName(Aws::String&& value) { m_scheduledActionNameHasBeenSet = true; m_scheduledActionName = std::move(value); } /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline void SetScheduledActionName(const char* value) { m_scheduledActionNameHasBeenSet = true; m_scheduledActionName.assign(value); } /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline PutScheduledActionRequest& WithScheduledActionName(const Aws::String& value) { SetScheduledActionName(value); return *this;} /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline PutScheduledActionRequest& WithScheduledActionName(Aws::String&& value) { SetScheduledActionName(std::move(value)); return *this;} /** - *

    The name of the scheduled action.

    + *

    The name of the scheduled action. This name must be unique among all other + * scheduled actions on the specified scalable target.

    */ inline PutScheduledActionRequest& WithScheduledActionName(const char* value) { SetScheduledActionName(value); return *this;} @@ -310,7 +330,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -351,7 +373,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -392,7 +416,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -433,7 +459,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -474,7 +502,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -515,7 +545,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScheduledActionRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -556,7 +588,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScheduledActionRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -597,7 +631,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline PutScheduledActionRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -630,7 +666,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -662,7 +702,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -694,7 +738,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -726,7 +774,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -758,7 +810,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline PutScheduledActionRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -790,124 +846,128 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline PutScheduledActionRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline PutScheduledActionRequest& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** - *

    The date and time for the scheduled action to start.

    + *

    The date and time for this scheduled action to start.

    */ inline PutScheduledActionRequest& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline PutScheduledActionRequest& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** - *

    The date and time for the scheduled action to end.

    + *

    The date and time for the recurring schedule to end.

    */ inline PutScheduledActionRequest& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline const ScalableTargetAction& GetScalableTargetAction() const{ return m_scalableTargetAction; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline bool ScalableTargetActionHasBeenSet() const { return m_scalableTargetActionHasBeenSet; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline void SetScalableTargetAction(const ScalableTargetAction& value) { m_scalableTargetActionHasBeenSet = true; m_scalableTargetAction = value; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline void SetScalableTargetAction(ScalableTargetAction&& value) { m_scalableTargetActionHasBeenSet = true; m_scalableTargetAction = std::move(value); } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline PutScheduledActionRequest& WithScalableTargetAction(const ScalableTargetAction& value) { SetScalableTargetAction(value); return *this;} /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline PutScheduledActionRequest& WithScalableTargetAction(ScalableTargetAction&& value) { SetScalableTargetAction(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/RegisterScalableTargetRequest.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/RegisterScalableTargetRequest.h index 1c7dc2bd1c9..9162a4d9d83 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/RegisterScalableTargetRequest.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/RegisterScalableTargetRequest.h @@ -48,56 +48,44 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline RegisterScalableTargetRequest& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource. For a resource + * provided by your own application or service, use custom-resource + * instead.

    */ inline RegisterScalableTargetRequest& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -139,7 +127,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -180,7 +170,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -221,7 +213,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -262,7 +256,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -303,7 +299,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -344,7 +342,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline RegisterScalableTargetRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -385,7 +385,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline RegisterScalableTargetRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -426,7 +428,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline RegisterScalableTargetRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -460,7 +464,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -493,7 +501,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -526,7 +538,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -559,7 +575,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -592,7 +612,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline RegisterScalableTargetRequest& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -625,146 +649,182 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline RegisterScalableTargetRequest& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} /** - *

    The minimum value to scale to in response to a scale-in event. - * MinCapacity is required to register a scalable target.

    + *

    The minimum value that you plan to scale in to. When a scaling policy is in + * effect, Application Auto Scaling can scale in (contract) as needed to the + * minimum capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target. For Lambda provisioned + * concurrency, the minimum value allowed is 0. For all other resources, the + * minimum value allowed is 1.

    */ inline int GetMinCapacity() const{ return m_minCapacity; } /** - *

    The minimum value to scale to in response to a scale-in event. - * MinCapacity is required to register a scalable target.

    + *

    The minimum value that you plan to scale in to. When a scaling policy is in + * effect, Application Auto Scaling can scale in (contract) as needed to the + * minimum capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target. For Lambda provisioned + * concurrency, the minimum value allowed is 0. For all other resources, the + * minimum value allowed is 1.

    */ inline bool MinCapacityHasBeenSet() const { return m_minCapacityHasBeenSet; } /** - *

    The minimum value to scale to in response to a scale-in event. - * MinCapacity is required to register a scalable target.

    + *

    The minimum value that you plan to scale in to. When a scaling policy is in + * effect, Application Auto Scaling can scale in (contract) as needed to the + * minimum capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target. For Lambda provisioned + * concurrency, the minimum value allowed is 0. For all other resources, the + * minimum value allowed is 1.

    */ inline void SetMinCapacity(int value) { m_minCapacityHasBeenSet = true; m_minCapacity = value; } /** - *

    The minimum value to scale to in response to a scale-in event. - * MinCapacity is required to register a scalable target.

    + *

    The minimum value that you plan to scale in to. When a scaling policy is in + * effect, Application Auto Scaling can scale in (contract) as needed to the + * minimum capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target. For Lambda provisioned + * concurrency, the minimum value allowed is 0. For all other resources, the + * minimum value allowed is 1.

    */ inline RegisterScalableTargetRequest& WithMinCapacity(int value) { SetMinCapacity(value); return *this;} /** - *

    The maximum value to scale to in response to a scale-out event. - * MaxCapacity is required to register a scalable target.

    + *

    The maximum value that you plan to scale out to. When a scaling policy is in + * effect, Application Auto Scaling can scale out (expand) as needed to the maximum + * capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target.

    */ inline int GetMaxCapacity() const{ return m_maxCapacity; } /** - *

    The maximum value to scale to in response to a scale-out event. - * MaxCapacity is required to register a scalable target.

    + *

    The maximum value that you plan to scale out to. When a scaling policy is in + * effect, Application Auto Scaling can scale out (expand) as needed to the maximum + * capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target.

    */ inline bool MaxCapacityHasBeenSet() const { return m_maxCapacityHasBeenSet; } /** - *

    The maximum value to scale to in response to a scale-out event. - * MaxCapacity is required to register a scalable target.

    + *

    The maximum value that you plan to scale out to. When a scaling policy is in + * effect, Application Auto Scaling can scale out (expand) as needed to the maximum + * capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target.

    */ inline void SetMaxCapacity(int value) { m_maxCapacityHasBeenSet = true; m_maxCapacity = value; } /** - *

    The maximum value to scale to in response to a scale-out event. - * MaxCapacity is required to register a scalable target.

    + *

    The maximum value that you plan to scale out to. When a scaling policy is in + * effect, Application Auto Scaling can scale out (expand) as needed to the maximum + * capacity limit in response to changing demand.

    This parameter is + * required if you are registering a scalable target.

    */ inline RegisterScalableTargetRequest& WithMaxCapacity(int value) { SetMaxCapacity(value); return *this;} /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline const Aws::String& GetRoleARN() const{ return m_roleARN; } /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline RegisterScalableTargetRequest& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline RegisterScalableTargetRequest& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} /** - *

    Application Auto Scaling creates a service-linked role that grants it - * permissions to modify the scalable target on your behalf. For more information, - * see Service-Linked - * Roles for Application Auto Scaling.

    For Amazon EMR, this parameter is - * required, and it must specify the ARN of an IAM role that allows Application - * Auto Scaling to modify the scalable target on your behalf.

    + *

    This parameter is required for services that do not support service-linked + * roles (such as Amazon EMR), and it must specify the ARN of an IAM role that + * allows Application Auto Scaling to modify the scalable target on your behalf. + *

    If the service supports service-linked roles, Application Auto Scaling + * uses a service-linked role, which it creates if it does not yet exist. For more + * information, see Application + * Auto Scaling IAM Roles.

    */ inline RegisterScalableTargetRequest& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableDimension.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableDimension.h index e89f061cd9a..55052e42972 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableDimension.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableDimension.h @@ -38,7 +38,9 @@ namespace Model sagemaker_variant_DesiredInstanceCount, custom_resource_ResourceType_Property, comprehend_document_classifier_endpoint_DesiredInferenceUnits, - lambda_function_ProvisionedConcurrency + lambda_function_ProvisionedConcurrency, + cassandra_table_ReadCapacityUnits, + cassandra_table_WriteCapacityUnits }; namespace ScalableDimensionMapper diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTarget.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTarget.h index a3b13476ad5..b9bcc4af453 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTarget.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTarget.h @@ -52,56 +52,38 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalableTarget& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalableTarget& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -143,7 +125,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -184,7 +168,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -225,7 +211,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -266,7 +254,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -307,7 +297,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -348,7 +340,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalableTarget& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -389,7 +383,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalableTarget& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -430,7 +426,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalableTarget& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -464,7 +462,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -497,7 +499,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -530,7 +536,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -563,7 +573,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -596,7 +610,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalableTarget& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -629,7 +647,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalableTarget& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTargetAction.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTargetAction.h index 69a1a2df0b8..a1b8f9d52dd 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTargetAction.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalableTargetAction.h @@ -47,22 +47,26 @@ namespace Model /** - *

    The minimum capacity.

    + *

    The minimum capacity.

    For Lambda provisioned concurrency, the minimum + * value allowed is 0. For all other resources, the minimum value allowed is 1.

    */ inline int GetMinCapacity() const{ return m_minCapacity; } /** - *

    The minimum capacity.

    + *

    The minimum capacity.

    For Lambda provisioned concurrency, the minimum + * value allowed is 0. For all other resources, the minimum value allowed is 1.

    */ inline bool MinCapacityHasBeenSet() const { return m_minCapacityHasBeenSet; } /** - *

    The minimum capacity.

    + *

    The minimum capacity.

    For Lambda provisioned concurrency, the minimum + * value allowed is 0. For all other resources, the minimum value allowed is 1.

    */ inline void SetMinCapacity(int value) { m_minCapacityHasBeenSet = true; m_minCapacity = value; } /** - *

    The minimum capacity.

    + *

    The minimum capacity.

    For Lambda provisioned concurrency, the minimum + * value allowed is 0. For all other resources, the minimum value allowed is 1.

    */ inline ScalableTargetAction& WithMinCapacity(int value) { SetMinCapacity(value); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingActivity.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingActivity.h index 74adcf12862..64a0f969ab3 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingActivity.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingActivity.h @@ -93,56 +93,38 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalingActivity& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalingActivity& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -184,7 +166,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -225,7 +209,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -266,7 +252,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -307,7 +295,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -348,7 +338,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -389,7 +381,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingActivity& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -430,7 +424,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingActivity& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -471,7 +467,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingActivity& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -504,7 +502,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -536,7 +538,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -568,7 +574,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -600,7 +610,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -632,7 +646,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalingActivity& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -664,7 +682,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalingActivity& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingPolicy.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingPolicy.h index 789e587343b..ebc5cb4cc05 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingPolicy.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScalingPolicy.h @@ -139,56 +139,38 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalingPolicy& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScalingPolicy& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -230,7 +212,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -271,7 +255,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -312,7 +298,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -353,7 +341,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -394,7 +384,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -435,7 +427,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingPolicy& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -476,7 +470,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingPolicy& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -517,7 +513,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScalingPolicy& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -550,7 +548,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -582,7 +584,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -614,7 +620,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -646,7 +656,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -678,7 +692,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalingPolicy& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -710,7 +728,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScalingPolicy& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScheduledAction.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScheduledAction.h index a78f5e4af5a..2dc4d69a66e 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScheduledAction.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ScheduledAction.h @@ -134,56 +134,38 @@ namespace Model /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline const ServiceNamespace& GetServiceNamespace() const{ return m_serviceNamespace; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline bool ServiceNamespaceHasBeenSet() const { return m_serviceNamespaceHasBeenSet; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(const ServiceNamespace& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = value; } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline void SetServiceNamespace(ServiceNamespace&& value) { m_serviceNamespaceHasBeenSet = true; m_serviceNamespace = std::move(value); } /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScheduledAction& WithServiceNamespace(const ServiceNamespace& value) { SetServiceNamespace(value); return *this;} /** - *

    The namespace of the AWS service that provides the resource or - * custom-resource for a resource provided by your own application or - * service. For more information, see AWS - * Service Namespaces in the Amazon Web Services General Reference.

    + *

    The namespace of the AWS service that provides the resource, or a + * custom-resource.

    */ inline ScheduledAction& WithServiceNamespace(ServiceNamespace&& value) { SetServiceNamespace(std::move(value)); return *this;} @@ -195,12 +177,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline const Aws::String& GetSchedule() const{ return m_schedule; } @@ -211,12 +196,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; } @@ -227,12 +215,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(const Aws::String& value) { m_scheduleHasBeenSet = true; m_schedule = value; } @@ -243,12 +234,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(Aws::String&& value) { m_scheduleHasBeenSet = true; m_schedule = std::move(value); } @@ -259,12 +253,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline void SetSchedule(const char* value) { m_scheduleHasBeenSet = true; m_schedule.assign(value); } @@ -275,12 +272,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline ScheduledAction& WithSchedule(const Aws::String& value) { SetSchedule(value); return *this;} @@ -291,12 +291,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline ScheduledAction& WithSchedule(Aws::String&& value) { SetSchedule(std::move(value)); return *this;} @@ -307,12 +310,15 @@ namespace Model *

  • Rate expressions - "rate(value * unit)"

  • Cron expressions - * "cron(fields)"

    • At expressions are useful - * for one-time schedules. Specify the time, in UTC.

    For rate expressions, + * for one-time schedules. Specify the time in UTC.

    For rate expressions, * value is a positive integer and unit is minute | * minutes | hour | hours | day * | days.

    For more information about cron expressions, see Cron - * Expressions in the Amazon CloudWatch Events User Guide.

    + * Expressions in the Amazon CloudWatch Events User Guide.

    For + * examples of using these expressions, see Scheduled + * Scaling in the Application Auto Scaling User Guide.

    */ inline ScheduledAction& WithSchedule(const char* value) { SetSchedule(value); return *this;} @@ -354,7 +360,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline const Aws::String& GetResourceId() const{ return m_resourceId; } @@ -395,7 +403,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } @@ -436,7 +446,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } @@ -477,7 +489,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } @@ -518,7 +532,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } @@ -559,7 +575,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScheduledAction& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} @@ -600,7 +618,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScheduledAction& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} @@ -641,7 +661,9 @@ namespace Model * function and the unique identifier is the function name with a * function version or alias name suffix that is not $LATEST. Example: * function:my-function:prod or - * function:my-function:1.

    + * function:my-function:1.

  • Amazon Keyspaces table - + * The resource type is table and the unique identifier is the table + * name. Example: keyspace/mykeyspace/table/mytable.

    • */ inline ScheduledAction& WithResourceId(const char* value) { SetResourceId(value); return *this;} @@ -674,7 +696,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline const ScalableDimension& GetScalableDimension() const{ return m_scalableDimension; } @@ -706,7 +732,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline bool ScalableDimensionHasBeenSet() const { return m_scalableDimensionHasBeenSet; } @@ -738,7 +768,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(const ScalableDimension& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = value; } @@ -770,7 +804,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline void SetScalableDimension(ScalableDimension&& value) { m_scalableDimensionHasBeenSet = true; m_scalableDimension = std::move(value); } @@ -802,7 +840,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScheduledAction& WithScalableDimension(const ScalableDimension& value) { SetScalableDimension(value); return *this;} @@ -834,7 +876,11 @@ namespace Model *

    comprehend:document-classifier-endpoint:DesiredInferenceUnits - * The number of inference units for an Amazon Comprehend document classification * endpoint.

  • lambda:function:ProvisionedConcurrency - * - The provisioned concurrency for a Lambda function.

    • + * - The provisioned concurrency for a Lambda function.

  • + * cassandra:table:ReadCapacityUnits - The provisioned read capacity + * for an Amazon Keyspaces table.

  • + * cassandra:table:WriteCapacityUnits - The provisioned write capacity + * for an Amazon Keyspaces table.

    • */ inline ScheduledAction& WithScalableDimension(ScalableDimension&& value) { SetScalableDimension(std::move(value)); return *this;} @@ -902,56 +948,56 @@ namespace Model /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline const ScalableTargetAction& GetScalableTargetAction() const{ return m_scalableTargetAction; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline bool ScalableTargetActionHasBeenSet() const { return m_scalableTargetActionHasBeenSet; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline void SetScalableTargetAction(const ScalableTargetAction& value) { m_scalableTargetActionHasBeenSet = true; m_scalableTargetAction = value; } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline void SetScalableTargetAction(ScalableTargetAction&& value) { m_scalableTargetActionHasBeenSet = true; m_scalableTargetAction = std::move(value); } /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline ScheduledAction& WithScalableTargetAction(const ScalableTargetAction& value) { SetScalableTargetAction(value); return *this;} /** - *

    The new minimum and maximum capacity. You can set both values or just one. - * During the scheduled time, if the current capacity is below the minimum - * capacity, Application Auto Scaling scales out to the minimum capacity. If the - * current capacity is above the maximum capacity, Application Auto Scaling scales - * in to the maximum capacity.

    + *

    The new minimum and maximum capacity. You can set both values or just one. At + * the scheduled time, if the current capacity is below the minimum capacity, + * Application Auto Scaling scales out to the minimum capacity. If the current + * capacity is above the maximum capacity, Application Auto Scaling scales in to + * the maximum capacity.

    */ inline ScheduledAction& WithScalableTargetAction(ScalableTargetAction&& value) { SetScalableTargetAction(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ServiceNamespace.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ServiceNamespace.h index 7b1d75a04d3..a04eadf79ed 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ServiceNamespace.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/ServiceNamespace.h @@ -35,7 +35,8 @@ namespace Model sagemaker, custom_resource, comprehend, - lambda + lambda, + cassandra }; namespace ServiceNamespaceMapper diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepAdjustment.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepAdjustment.h index 367f47486b5..ce51bfb0960 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepAdjustment.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepAdjustment.h @@ -32,7 +32,8 @@ namespace Model { /** - *

    Represents a step adjustment for a StepScalingPolicyConfiguration. + *

    Represents a step adjustment for a StepScalingPolicyConfiguration. * Describes an adjustment based on the difference between the value of the * aggregated CloudWatch metric and the breach threshold that you've defined for * the alarm.

    For the following examples, suppose that you have an alarm @@ -146,29 +147,29 @@ namespace Model /** *

    The amount by which to scale, based on the specified adjustment type. A - * positive value adds to the current scalable dimension while a negative number - * removes from the current scalable dimension.

    + * positive value adds to the current capacity while a negative number removes from + * the current capacity.

    */ inline int GetScalingAdjustment() const{ return m_scalingAdjustment; } /** *

    The amount by which to scale, based on the specified adjustment type. A - * positive value adds to the current scalable dimension while a negative number - * removes from the current scalable dimension.

    + * positive value adds to the current capacity while a negative number removes from + * the current capacity.

    */ inline bool ScalingAdjustmentHasBeenSet() const { return m_scalingAdjustmentHasBeenSet; } /** *

    The amount by which to scale, based on the specified adjustment type. A - * positive value adds to the current scalable dimension while a negative number - * removes from the current scalable dimension.

    + * positive value adds to the current capacity while a negative number removes from + * the current capacity.

    */ inline void SetScalingAdjustment(int value) { m_scalingAdjustmentHasBeenSet = true; m_scalingAdjustment = value; } /** *

    The amount by which to scale, based on the specified adjustment type. A - * positive value adds to the current scalable dimension while a negative number - * removes from the current scalable dimension.

    + * positive value adds to the current capacity while a negative number removes from + * the current capacity.

    */ inline StepAdjustment& WithScalingAdjustment(int value) { SetScalingAdjustment(value); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepScalingPolicyConfiguration.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepScalingPolicyConfiguration.h index 2aebf4fba8c..f29239e1e57 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepScalingPolicyConfiguration.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/StepScalingPolicyConfiguration.h @@ -52,146 +52,158 @@ namespace Model /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline const AdjustmentType& GetAdjustmentType() const{ return m_adjustmentType; } /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline bool AdjustmentTypeHasBeenSet() const { return m_adjustmentTypeHasBeenSet; } /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline void SetAdjustmentType(const AdjustmentType& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = value; } /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline void SetAdjustmentType(AdjustmentType&& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = std::move(value); } /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline StepScalingPolicyConfiguration& WithAdjustmentType(const AdjustmentType& value) { SetAdjustmentType(value); return *this;} /** - *

    Specifies whether the ScalingAdjustment value in a - * StepAdjustment is an absolute number or a percentage of the current - * capacity.

    + *

    Specifies whether the ScalingAdjustment value in a StepAdjustment + * is an absolute number or a percentage of the current capacity.

    + * AdjustmentType is required if you are adding a new step scaling + * policy configuration.

    */ inline StepScalingPolicyConfiguration& WithAdjustmentType(AdjustmentType&& value) { SetAdjustmentType(std::move(value)); return *this;} /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline const Aws::Vector& GetStepAdjustments() const{ return m_stepAdjustments; } /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline bool StepAdjustmentsHasBeenSet() const { return m_stepAdjustmentsHasBeenSet; } /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline void SetStepAdjustments(const Aws::Vector& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = value; } /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline void SetStepAdjustments(Aws::Vector&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = std::move(value); } /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline StepScalingPolicyConfiguration& WithStepAdjustments(const Aws::Vector& value) { SetStepAdjustments(value); return *this;} /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline StepScalingPolicyConfiguration& WithStepAdjustments(Aws::Vector&& value) { SetStepAdjustments(std::move(value)); return *this;} /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline StepScalingPolicyConfiguration& AddStepAdjustments(const StepAdjustment& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(value); return *this; } /** *

    A set of adjustments that enable you to scale based on the size of the alarm - * breach.

    + * breach.

    At least one step adjustment is required if you are adding a new + * step scaling policy configuration.

    */ inline StepScalingPolicyConfiguration& AddStepAdjustments(StepAdjustment&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(std::move(value)); return *this; } /** - *

    The minimum number to adjust your scalable dimension as a result of a scaling - * activity. If the adjustment type is PercentChangeInCapacity, the - * scaling policy changes the scalable dimension of the scalable target by this - * amount.

    For example, suppose that you create a step scaling policy to - * scale out an Amazon ECS service by 25 percent and you specify a - * MinAdjustmentMagnitude of 2. If the service has 4 tasks and the - * scaling policy is performed, 25 percent of 4 is 1. However, because you - * specified a MinAdjustmentMagnitude of 2, Application Auto Scaling - * scales out the service by 2 tasks.

    + *

    The minimum value to scale by when scaling by percentages. For example, + * suppose that you create a step scaling policy to scale out an Amazon ECS service + * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the + * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. + * However, because you specified a MinAdjustmentMagnitude of 2, + * Application Auto Scaling scales out the service by 2 tasks.

    Valid only if + * the adjustment type is PercentChangeInCapacity.

    */ inline int GetMinAdjustmentMagnitude() const{ return m_minAdjustmentMagnitude; } /** - *

    The minimum number to adjust your scalable dimension as a result of a scaling - * activity. If the adjustment type is PercentChangeInCapacity, the - * scaling policy changes the scalable dimension of the scalable target by this - * amount.

    For example, suppose that you create a step scaling policy to - * scale out an Amazon ECS service by 25 percent and you specify a - * MinAdjustmentMagnitude of 2. If the service has 4 tasks and the - * scaling policy is performed, 25 percent of 4 is 1. However, because you - * specified a MinAdjustmentMagnitude of 2, Application Auto Scaling - * scales out the service by 2 tasks.

    + *

    The minimum value to scale by when scaling by percentages. For example, + * suppose that you create a step scaling policy to scale out an Amazon ECS service + * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the + * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. + * However, because you specified a MinAdjustmentMagnitude of 2, + * Application Auto Scaling scales out the service by 2 tasks.

    Valid only if + * the adjustment type is PercentChangeInCapacity.

    */ inline bool MinAdjustmentMagnitudeHasBeenSet() const { return m_minAdjustmentMagnitudeHasBeenSet; } /** - *

    The minimum number to adjust your scalable dimension as a result of a scaling - * activity. If the adjustment type is PercentChangeInCapacity, the - * scaling policy changes the scalable dimension of the scalable target by this - * amount.

    For example, suppose that you create a step scaling policy to - * scale out an Amazon ECS service by 25 percent and you specify a - * MinAdjustmentMagnitude of 2. If the service has 4 tasks and the - * scaling policy is performed, 25 percent of 4 is 1. However, because you - * specified a MinAdjustmentMagnitude of 2, Application Auto Scaling - * scales out the service by 2 tasks.

    + *

    The minimum value to scale by when scaling by percentages. For example, + * suppose that you create a step scaling policy to scale out an Amazon ECS service + * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the + * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. + * However, because you specified a MinAdjustmentMagnitude of 2, + * Application Auto Scaling scales out the service by 2 tasks.

    Valid only if + * the adjustment type is PercentChangeInCapacity.

    */ inline void SetMinAdjustmentMagnitude(int value) { m_minAdjustmentMagnitudeHasBeenSet = true; m_minAdjustmentMagnitude = value; } /** - *

    The minimum number to adjust your scalable dimension as a result of a scaling - * activity. If the adjustment type is PercentChangeInCapacity, the - * scaling policy changes the scalable dimension of the scalable target by this - * amount.

    For example, suppose that you create a step scaling policy to - * scale out an Amazon ECS service by 25 percent and you specify a - * MinAdjustmentMagnitude of 2. If the service has 4 tasks and the - * scaling policy is performed, 25 percent of 4 is 1. However, because you - * specified a MinAdjustmentMagnitude of 2, Application Auto Scaling - * scales out the service by 2 tasks.

    + *

    The minimum value to scale by when scaling by percentages. For example, + * suppose that you create a step scaling policy to scale out an Amazon ECS service + * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the + * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. + * However, because you specified a MinAdjustmentMagnitude of 2, + * Application Auto Scaling scales out the service by 2 tasks.

    Valid only if + * the adjustment type is PercentChangeInCapacity.

    */ inline StepScalingPolicyConfiguration& WithMinAdjustmentMagnitude(int value) { SetMinAdjustmentMagnitude(value); return *this;} @@ -200,21 +212,30 @@ namespace Model *

    The amount of time, in seconds, after a scaling activity completes where * previous trigger-related scaling activities can influence future scaling * events.

    For scale-out policies, while the cooldown period is in effect, - * the capacity that has been added by the previous scale-out event that initiated + * the capacity that has been added by the previous scale-out action that initiated * the cooldown is calculated as part of the desired capacity for the next scale * out. The intention is to continuously (but not excessively) scale out. For * example, an alarm triggers a step scaling policy to scale out an Amazon ECS * service by 2 tasks, the scaling activity completes successfully, and a cooldown * period of 5 minutes starts. During the cooldown period, if the alarm triggers * the same policy again but at a more aggressive step adjustment to scale out the - * service by 3 tasks, the 2 tasks that were added in the previous scale-out event + * service by 3 tasks, the 2 tasks that were added in the previous scale-out action * are considered part of that capacity and only 1 additional task is added to the * desired count.

    For scale-in policies, the cooldown period is used to * block subsequent scale-in requests until it has expired. The intention is to * scale in conservatively to protect your application's availability. However, if * another alarm triggers a scale-out policy during the cooldown period after a * scale-in, Application Auto Scaling scales out your scalable target - * immediately.

    + * immediately.

    Application Auto Scaling provides a default value of 300 for + * the following scalable targets:

    • ECS services

    • + *

      Spot Fleet requests

    • EMR clusters

    • + *

      AppStream 2.0 fleets

    • Aurora DB clusters

    • + *

      Amazon SageMaker endpoint variants

    • Custom resources

      + *

    For all other scalable targets, the default value is 0:

      + *

    • DynamoDB tables

    • DynamoDB global secondary indexes

      + *

    • Amazon Comprehend document classification endpoints

    • + *

      Lambda provisioned concurrency

    • Amazon Keyspaces tables

      + *
    */ inline int GetCooldown() const{ return m_cooldown; } @@ -222,21 +243,30 @@ namespace Model *

    The amount of time, in seconds, after a scaling activity completes where * previous trigger-related scaling activities can influence future scaling * events.

    For scale-out policies, while the cooldown period is in effect, - * the capacity that has been added by the previous scale-out event that initiated + * the capacity that has been added by the previous scale-out action that initiated * the cooldown is calculated as part of the desired capacity for the next scale * out. The intention is to continuously (but not excessively) scale out. For * example, an alarm triggers a step scaling policy to scale out an Amazon ECS * service by 2 tasks, the scaling activity completes successfully, and a cooldown * period of 5 minutes starts. During the cooldown period, if the alarm triggers * the same policy again but at a more aggressive step adjustment to scale out the - * service by 3 tasks, the 2 tasks that were added in the previous scale-out event + * service by 3 tasks, the 2 tasks that were added in the previous scale-out action * are considered part of that capacity and only 1 additional task is added to the * desired count.

    For scale-in policies, the cooldown period is used to * block subsequent scale-in requests until it has expired. The intention is to * scale in conservatively to protect your application's availability. However, if * another alarm triggers a scale-out policy during the cooldown period after a * scale-in, Application Auto Scaling scales out your scalable target - * immediately.

    + * immediately.

    Application Auto Scaling provides a default value of 300 for + * the following scalable targets:

    • ECS services

    • + *

      Spot Fleet requests

    • EMR clusters

    • + *

      AppStream 2.0 fleets

    • Aurora DB clusters

    • + *

      Amazon SageMaker endpoint variants

    • Custom resources

      + *

    For all other scalable targets, the default value is 0:

      + *

    • DynamoDB tables

    • DynamoDB global secondary indexes

      + *

    • Amazon Comprehend document classification endpoints

    • + *

      Lambda provisioned concurrency

    • Amazon Keyspaces tables

      + *
    */ inline bool CooldownHasBeenSet() const { return m_cooldownHasBeenSet; } @@ -244,21 +274,30 @@ namespace Model *

    The amount of time, in seconds, after a scaling activity completes where * previous trigger-related scaling activities can influence future scaling * events.

    For scale-out policies, while the cooldown period is in effect, - * the capacity that has been added by the previous scale-out event that initiated + * the capacity that has been added by the previous scale-out action that initiated * the cooldown is calculated as part of the desired capacity for the next scale * out. The intention is to continuously (but not excessively) scale out. For * example, an alarm triggers a step scaling policy to scale out an Amazon ECS * service by 2 tasks, the scaling activity completes successfully, and a cooldown * period of 5 minutes starts. During the cooldown period, if the alarm triggers * the same policy again but at a more aggressive step adjustment to scale out the - * service by 3 tasks, the 2 tasks that were added in the previous scale-out event + * service by 3 tasks, the 2 tasks that were added in the previous scale-out action * are considered part of that capacity and only 1 additional task is added to the * desired count.

    For scale-in policies, the cooldown period is used to * block subsequent scale-in requests until it has expired. The intention is to * scale in conservatively to protect your application's availability. However, if * another alarm triggers a scale-out policy during the cooldown period after a * scale-in, Application Auto Scaling scales out your scalable target - * immediately.

    + * immediately.

    Application Auto Scaling provides a default value of 300 for + * the following scalable targets:

    • ECS services

    • + *

      Spot Fleet requests

    • EMR clusters

    • + *

      AppStream 2.0 fleets

    • Aurora DB clusters

    • + *

      Amazon SageMaker endpoint variants

    • Custom resources

      + *

    For all other scalable targets, the default value is 0:

      + *

    • DynamoDB tables

    • DynamoDB global secondary indexes

      + *

    • Amazon Comprehend document classification endpoints

    • + *

      Lambda provisioned concurrency

    • Amazon Keyspaces tables

      + *
    */ inline void SetCooldown(int value) { m_cooldownHasBeenSet = true; m_cooldown = value; } @@ -266,21 +305,30 @@ namespace Model *

    The amount of time, in seconds, after a scaling activity completes where * previous trigger-related scaling activities can influence future scaling * events.

    For scale-out policies, while the cooldown period is in effect, - * the capacity that has been added by the previous scale-out event that initiated + * the capacity that has been added by the previous scale-out action that initiated * the cooldown is calculated as part of the desired capacity for the next scale * out. The intention is to continuously (but not excessively) scale out. For * example, an alarm triggers a step scaling policy to scale out an Amazon ECS * service by 2 tasks, the scaling activity completes successfully, and a cooldown * period of 5 minutes starts. During the cooldown period, if the alarm triggers * the same policy again but at a more aggressive step adjustment to scale out the - * service by 3 tasks, the 2 tasks that were added in the previous scale-out event + * service by 3 tasks, the 2 tasks that were added in the previous scale-out action * are considered part of that capacity and only 1 additional task is added to the * desired count.

    For scale-in policies, the cooldown period is used to * block subsequent scale-in requests until it has expired. The intention is to * scale in conservatively to protect your application's availability. However, if * another alarm triggers a scale-out policy during the cooldown period after a * scale-in, Application Auto Scaling scales out your scalable target - * immediately.

    + * immediately.

    Application Auto Scaling provides a default value of 300 for + * the following scalable targets:

    • ECS services

    • + *

      Spot Fleet requests

    • EMR clusters

    • + *

      AppStream 2.0 fleets

    • Aurora DB clusters

    • + *

      Amazon SageMaker endpoint variants

    • Custom resources

      + *

    For all other scalable targets, the default value is 0:

      + *

    • DynamoDB tables

    • DynamoDB global secondary indexes

      + *

    • Amazon Comprehend document classification endpoints

    • + *

      Lambda provisioned concurrency

    • Amazon Keyspaces tables

      + *
    */ inline StepScalingPolicyConfiguration& WithCooldown(int value) { SetCooldown(value); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/TargetTrackingScalingPolicyConfiguration.h b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/TargetTrackingScalingPolicyConfiguration.h index 20d6f74e518..0ddcd2f2cbf 100644 --- a/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/TargetTrackingScalingPolicyConfiguration.h +++ b/aws-cpp-sdk-application-autoscaling/include/aws/application-autoscaling/model/TargetTrackingScalingPolicyConfiguration.h @@ -151,40 +151,76 @@ namespace Model /** *

    The amount of time, in seconds, after a scale-out activity completes before * another scale-out activity can start.

    While the cooldown period is in - * effect, the capacity that has been added by the previous scale-out event that + * effect, the capacity that has been added by the previous scale-out action that * initiated the cooldown is calculated as part of the desired capacity for the * next scale out. The intention is to continuously (but not excessively) scale - * out.

    + * out.

    Application Auto Scaling provides a default value of 300 for the + * following scalable targets:

    • ECS services

    • Spot + * Fleet requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline int GetScaleOutCooldown() const{ return m_scaleOutCooldown; } /** *

    The amount of time, in seconds, after a scale-out activity completes before * another scale-out activity can start.

    While the cooldown period is in - * effect, the capacity that has been added by the previous scale-out event that + * effect, the capacity that has been added by the previous scale-out action that * initiated the cooldown is calculated as part of the desired capacity for the * next scale out. The intention is to continuously (but not excessively) scale - * out.

    + * out.

    Application Auto Scaling provides a default value of 300 for the + * following scalable targets:

    • ECS services

    • Spot + * Fleet requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline bool ScaleOutCooldownHasBeenSet() const { return m_scaleOutCooldownHasBeenSet; } /** *

    The amount of time, in seconds, after a scale-out activity completes before * another scale-out activity can start.

    While the cooldown period is in - * effect, the capacity that has been added by the previous scale-out event that + * effect, the capacity that has been added by the previous scale-out action that * initiated the cooldown is calculated as part of the desired capacity for the * next scale out. The intention is to continuously (but not excessively) scale - * out.

    + * out.

    Application Auto Scaling provides a default value of 300 for the + * following scalable targets:

    • ECS services

    • Spot + * Fleet requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline void SetScaleOutCooldown(int value) { m_scaleOutCooldownHasBeenSet = true; m_scaleOutCooldown = value; } /** *

    The amount of time, in seconds, after a scale-out activity completes before * another scale-out activity can start.

    While the cooldown period is in - * effect, the capacity that has been added by the previous scale-out event that + * effect, the capacity that has been added by the previous scale-out action that * initiated the cooldown is calculated as part of the desired capacity for the * next scale out. The intention is to continuously (but not excessively) scale - * out.

    + * out.

    Application Auto Scaling provides a default value of 300 for the + * following scalable targets:

    • ECS services

    • Spot + * Fleet requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline TargetTrackingScalingPolicyConfiguration& WithScaleOutCooldown(int value) { SetScaleOutCooldown(value); return *this;} @@ -196,6 +232,16 @@ namespace Model * conservatively to protect your application's availability. However, if another * alarm triggers a scale-out policy during the cooldown period after a scale-in, * Application Auto Scaling scales out your scalable target immediately.

    + *

    Application Auto Scaling provides a default value of 300 for the following + * scalable targets:

    • ECS services

    • Spot Fleet + * requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline int GetScaleInCooldown() const{ return m_scaleInCooldown; } @@ -206,6 +252,16 @@ namespace Model * conservatively to protect your application's availability. However, if another * alarm triggers a scale-out policy during the cooldown period after a scale-in, * Application Auto Scaling scales out your scalable target immediately.

    + *

    Application Auto Scaling provides a default value of 300 for the following + * scalable targets:

    • ECS services

    • Spot Fleet + * requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline bool ScaleInCooldownHasBeenSet() const { return m_scaleInCooldownHasBeenSet; } @@ -216,6 +272,16 @@ namespace Model * conservatively to protect your application's availability. However, if another * alarm triggers a scale-out policy during the cooldown period after a scale-in, * Application Auto Scaling scales out your scalable target immediately.

    + *

    Application Auto Scaling provides a default value of 300 for the following + * scalable targets:

    • ECS services

    • Spot Fleet + * requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline void SetScaleInCooldown(int value) { m_scaleInCooldownHasBeenSet = true; m_scaleInCooldown = value; } @@ -226,6 +292,16 @@ namespace Model * conservatively to protect your application's availability. However, if another * alarm triggers a scale-out policy during the cooldown period after a scale-in, * Application Auto Scaling scales out your scalable target immediately.

    + *

    Application Auto Scaling provides a default value of 300 for the following + * scalable targets:

    • ECS services

    • Spot Fleet + * requests

    • EMR clusters

    • AppStream 2.0 + * fleets

    • Aurora DB clusters

    • Amazon SageMaker + * endpoint variants

    • Custom resources

    For all + * other scalable targets, the default value is 0:

    • DynamoDB + * tables

    • DynamoDB global secondary indexes

    • + *

      Amazon Comprehend document classification endpoints

    • Lambda + * provisioned concurrency

    • Amazon Keyspaces tables

      • + *
    */ inline TargetTrackingScalingPolicyConfiguration& WithScaleInCooldown(int value) { SetScaleInCooldown(value); return *this;} @@ -233,36 +309,36 @@ namespace Model /** *

    Indicates whether scale in by the target tracking scaling policy is disabled. * If the value is true, scale in is disabled and the target tracking - * scaling policy won't remove capacity from the scalable resource. Otherwise, - * scale in is enabled and the target tracking scaling policy can remove capacity - * from the scalable resource. The default value is false.

    + * scaling policy won't remove capacity from the scalable target. Otherwise, scale + * in is enabled and the target tracking scaling policy can remove capacity from + * the scalable target. The default value is false.

    */ inline bool GetDisableScaleIn() const{ return m_disableScaleIn; } /** *

    Indicates whether scale in by the target tracking scaling policy is disabled. * If the value is true, scale in is disabled and the target tracking - * scaling policy won't remove capacity from the scalable resource. Otherwise, - * scale in is enabled and the target tracking scaling policy can remove capacity - * from the scalable resource. The default value is false.

    + * scaling policy won't remove capacity from the scalable target. Otherwise, scale + * in is enabled and the target tracking scaling policy can remove capacity from + * the scalable target. The default value is false.

    */ inline bool DisableScaleInHasBeenSet() const { return m_disableScaleInHasBeenSet; } /** *

    Indicates whether scale in by the target tracking scaling policy is disabled. * If the value is true, scale in is disabled and the target tracking - * scaling policy won't remove capacity from the scalable resource. Otherwise, - * scale in is enabled and the target tracking scaling policy can remove capacity - * from the scalable resource. The default value is false.

    + * scaling policy won't remove capacity from the scalable target. Otherwise, scale + * in is enabled and the target tracking scaling policy can remove capacity from + * the scalable target. The default value is false.

    */ inline void SetDisableScaleIn(bool value) { m_disableScaleInHasBeenSet = true; m_disableScaleIn = value; } /** *

    Indicates whether scale in by the target tracking scaling policy is disabled. * If the value is true, scale in is disabled and the target tracking - * scaling policy won't remove capacity from the scalable resource. Otherwise, - * scale in is enabled and the target tracking scaling policy can remove capacity - * from the scalable resource. The default value is false.

    + * scaling policy won't remove capacity from the scalable target. Otherwise, scale + * in is enabled and the target tracking scaling policy can remove capacity from + * the scalable target. The default value is false.

    */ inline TargetTrackingScalingPolicyConfiguration& WithDisableScaleIn(bool value) { SetDisableScaleIn(value); return *this;} diff --git a/aws-cpp-sdk-application-autoscaling/source/model/MetricType.cpp b/aws-cpp-sdk-application-autoscaling/source/model/MetricType.cpp index 7e4e876e644..a169010e64c 100644 --- a/aws-cpp-sdk-application-autoscaling/source/model/MetricType.cpp +++ b/aws-cpp-sdk-application-autoscaling/source/model/MetricType.cpp @@ -44,6 +44,8 @@ namespace Aws static const int AppStreamAverageCapacityUtilization_HASH = HashingUtils::HashString("AppStreamAverageCapacityUtilization"); static const int ComprehendInferenceUtilization_HASH = HashingUtils::HashString("ComprehendInferenceUtilization"); static const int LambdaProvisionedConcurrencyUtilization_HASH = HashingUtils::HashString("LambdaProvisionedConcurrencyUtilization"); + static const int CassandraReadCapacityUtilization_HASH = HashingUtils::HashString("CassandraReadCapacityUtilization"); + static const int CassandraWriteCapacityUtilization_HASH = HashingUtils::HashString("CassandraWriteCapacityUtilization"); MetricType GetMetricTypeForName(const Aws::String& name) @@ -105,6 +107,14 @@ namespace Aws { return MetricType::LambdaProvisionedConcurrencyUtilization; } + else if (hashCode == CassandraReadCapacityUtilization_HASH) + { + return MetricType::CassandraReadCapacityUtilization; + } + else if (hashCode == CassandraWriteCapacityUtilization_HASH) + { + return MetricType::CassandraWriteCapacityUtilization; + } EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) { @@ -147,6 +157,10 @@ namespace Aws return "ComprehendInferenceUtilization"; case MetricType::LambdaProvisionedConcurrencyUtilization: return "LambdaProvisionedConcurrencyUtilization"; + case MetricType::CassandraReadCapacityUtilization: + return "CassandraReadCapacityUtilization"; + case MetricType::CassandraWriteCapacityUtilization: + return "CassandraWriteCapacityUtilization"; default: EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) diff --git a/aws-cpp-sdk-application-autoscaling/source/model/ScalableDimension.cpp b/aws-cpp-sdk-application-autoscaling/source/model/ScalableDimension.cpp index 3c30c5699cb..9a2555bd893 100644 --- a/aws-cpp-sdk-application-autoscaling/source/model/ScalableDimension.cpp +++ b/aws-cpp-sdk-application-autoscaling/source/model/ScalableDimension.cpp @@ -43,6 +43,8 @@ namespace Aws static const int custom_resource_ResourceType_Property_HASH = HashingUtils::HashString("custom-resource:ResourceType:Property"); static const int comprehend_document_classifier_endpoint_DesiredInferenceUnits_HASH = HashingUtils::HashString("comprehend:document-classifier-endpoint:DesiredInferenceUnits"); static const int lambda_function_ProvisionedConcurrency_HASH = HashingUtils::HashString("lambda:function:ProvisionedConcurrency"); + static const int cassandra_table_ReadCapacityUnits_HASH = HashingUtils::HashString("cassandra:table:ReadCapacityUnits"); + static const int cassandra_table_WriteCapacityUnits_HASH = HashingUtils::HashString("cassandra:table:WriteCapacityUnits"); ScalableDimension GetScalableDimensionForName(const Aws::String& name) @@ -100,6 +102,14 @@ namespace Aws { return ScalableDimension::lambda_function_ProvisionedConcurrency; } + else if (hashCode == cassandra_table_ReadCapacityUnits_HASH) + { + return ScalableDimension::cassandra_table_ReadCapacityUnits; + } + else if (hashCode == cassandra_table_WriteCapacityUnits_HASH) + { + return ScalableDimension::cassandra_table_WriteCapacityUnits; + } EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) { @@ -140,6 +150,10 @@ namespace Aws return "comprehend:document-classifier-endpoint:DesiredInferenceUnits"; case ScalableDimension::lambda_function_ProvisionedConcurrency: return "lambda:function:ProvisionedConcurrency"; + case ScalableDimension::cassandra_table_ReadCapacityUnits: + return "cassandra:table:ReadCapacityUnits"; + case ScalableDimension::cassandra_table_WriteCapacityUnits: + return "cassandra:table:WriteCapacityUnits"; default: EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) diff --git a/aws-cpp-sdk-application-autoscaling/source/model/ServiceNamespace.cpp b/aws-cpp-sdk-application-autoscaling/source/model/ServiceNamespace.cpp index 1d53d9caaa6..e800bb196c3 100644 --- a/aws-cpp-sdk-application-autoscaling/source/model/ServiceNamespace.cpp +++ b/aws-cpp-sdk-application-autoscaling/source/model/ServiceNamespace.cpp @@ -40,6 +40,7 @@ namespace Aws static const int custom_resource_HASH = HashingUtils::HashString("custom-resource"); static const int comprehend_HASH = HashingUtils::HashString("comprehend"); static const int lambda_HASH = HashingUtils::HashString("lambda"); + static const int cassandra_HASH = HashingUtils::HashString("cassandra"); ServiceNamespace GetServiceNamespaceForName(const Aws::String& name) @@ -85,6 +86,10 @@ namespace Aws { return ServiceNamespace::lambda; } + else if (hashCode == cassandra_HASH) + { + return ServiceNamespace::cassandra; + } EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) { @@ -119,6 +124,8 @@ namespace Aws return "comprehend"; case ServiceNamespace::lambda: return "lambda"; + case ServiceNamespace::cassandra: + return "cassandra"; default: EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferClient.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferClient.h index 1575b6e342b..b4b6a31754f 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferClient.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/TransferClient.h @@ -152,16 +152,16 @@ namespace Model typedef std::function&) > UpdateUserResponseReceivedHandler; /** - *

    AWS Transfer for SFTP is a fully managed service that enables the transfer of - * files directly into and out of Amazon S3 using the Secure File Transfer Protocol - * (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you - * seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by - * integrating with existing authentication systems, and providing DNS routing with - * Amazon Route 53—so nothing changes for your customers and partners, or their - * applications. With your data in S3, you can use it with AWS services for - * processing, analytics, machine learning, and archiving. Getting started with AWS - * Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set - * up.

    + *

    AWS Transfer Family is a fully managed service that enables the transfer of + * files over the the File Transfer Protocol (FTP), File Transfer Protocol over SSL + * (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and + * out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly + * migrate your file transfer workflows to AWS Transfer Family by integrating with + * existing authentication systems, and providing DNS routing with Amazon Route 53 + * so nothing changes for your customers and partners, or their applications. With + * your data in Amazon S3, you can use it with AWS services for processing, + * analytics, machine learning, and archiving. Getting started with AWS Transfer + * Family is easy since there is no infrastructure to buy and set up.

    */ class AWS_TRANSFER_API TransferClient : public Aws::Client::AWSJsonClient { @@ -193,20 +193,22 @@ namespace Model /** - *

    Instantiates an autoscaling virtual server based on Secure File Transfer - * Protocol (SFTP) in AWS. When you make updates to your server or when you work - * with users, use the service-generated ServerId property that is - * assigned to the newly created server.

    See Also:

    Instantiates an autoscaling virtual server based on the selected file + * transfer protocol in AWS. When you make updates to your file transfer + * protocol-enabled server or when you work with users, use the service-generated + * ServerId property that is assigned to the newly created + * server.

    See Also:

    AWS * API Reference

    */ virtual Model::CreateServerOutcome CreateServer(const Model::CreateServerRequest& request) const; /** - *

    Instantiates an autoscaling virtual server based on Secure File Transfer - * Protocol (SFTP) in AWS. When you make updates to your server or when you work - * with users, use the service-generated ServerId property that is - * assigned to the newly created server.

    See Also:

    Instantiates an autoscaling virtual server based on the selected file + * transfer protocol in AWS. When you make updates to your file transfer + * protocol-enabled server or when you work with users, use the service-generated + * ServerId property that is assigned to the newly created + * server.

    See Also:

    AWS * API Reference

    * @@ -215,10 +217,11 @@ namespace Model virtual Model::CreateServerOutcomeCallable CreateServerCallable(const Model::CreateServerRequest& request) const; /** - *

    Instantiates an autoscaling virtual server based on Secure File Transfer - * Protocol (SFTP) in AWS. When you make updates to your server or when you work - * with users, use the service-generated ServerId property that is - * assigned to the newly created server.

    See Also:

    Instantiates an autoscaling virtual server based on the selected file + * transfer protocol in AWS. When you make updates to your file transfer + * protocol-enabled server or when you work with users, use the service-generated + * ServerId property that is assigned to the newly created + * server.

    See Also:

    AWS * API Reference

    * @@ -227,9 +230,9 @@ namespace Model virtual void CreateServerAsync(const Model::CreateServerRequest& request, const CreateServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Creates a user and associates them with an existing Secure File Transfer - * Protocol (SFTP) server. You can only create and associate users with SFTP - * servers that have the IdentityProviderType set to + *

    Creates a user and associates them with an existing file transfer + * protocol-enabled server. You can only create and associate users with servers + * that have the IdentityProviderType set to * SERVICE_MANAGED. Using parameters for CreateUser, you * can specify the user name, set the home directory, store the user's public key, * and assign the user's AWS Identity and Access Management (IAM) role. You can @@ -241,9 +244,9 @@ namespace Model virtual Model::CreateUserOutcome CreateUser(const Model::CreateUserRequest& request) const; /** - *

    Creates a user and associates them with an existing Secure File Transfer - * Protocol (SFTP) server. You can only create and associate users with SFTP - * servers that have the IdentityProviderType set to + *

    Creates a user and associates them with an existing file transfer + * protocol-enabled server. You can only create and associate users with servers + * that have the IdentityProviderType set to * SERVICE_MANAGED. Using parameters for CreateUser, you * can specify the user name, set the home directory, store the user's public key, * and assign the user's AWS Identity and Access Management (IAM) role. You can @@ -257,9 +260,9 @@ namespace Model virtual Model::CreateUserOutcomeCallable CreateUserCallable(const Model::CreateUserRequest& request) const; /** - *

    Creates a user and associates them with an existing Secure File Transfer - * Protocol (SFTP) server. You can only create and associate users with SFTP - * servers that have the IdentityProviderType set to + *

    Creates a user and associates them with an existing file transfer + * protocol-enabled server. You can only create and associate users with servers + * that have the IdentityProviderType set to * SERVICE_MANAGED. Using parameters for CreateUser, you * can specify the user name, set the home directory, store the user's public key, * and assign the user's AWS Identity and Access Management (IAM) role. You can @@ -273,16 +276,16 @@ namespace Model virtual void CreateUserAsync(const Model::CreateUserRequest& request, const CreateUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

    - *

    No response returns from this operation.

    See Also:

    Deletes the file transfer protocol-enabled server that you specify.

    No + * response returns from this operation.

    See Also:

    AWS * API Reference

    */ virtual Model::DeleteServerOutcome DeleteServer(const Model::DeleteServerRequest& request) const; /** - *

    Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

    - *

    No response returns from this operation.

    See Also:

    Deletes the file transfer protocol-enabled server that you specify.

    No + * response returns from this operation.

    See Also:

    AWS * API Reference

    * @@ -291,8 +294,8 @@ namespace Model virtual Model::DeleteServerOutcomeCallable DeleteServerCallable(const Model::DeleteServerRequest& request) const; /** - *

    Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

    - *

    No response returns from this operation.

    See Also:

    Deletes the file transfer protocol-enabled server that you specify.

    No + * response returns from this operation.

    See Also:

    AWS * API Reference

    * @@ -329,18 +332,20 @@ namespace Model virtual void DeleteSshPublicKeyAsync(const Model::DeleteSshPublicKeyRequest& request, const DeleteSshPublicKeyResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Deletes the user belonging to the server you specify.

    No response - * returns from this operation.

    When you delete a user from a server, - * the user's information is lost.

    See Also:

    Deletes the user belonging to a file transfer protocol-enabled server you + * specify.

    No response returns from this operation.

    When you + * delete a user from a server, the user's information is lost.

    + *

    See Also:

    AWS * API Reference

    */ virtual Model::DeleteUserOutcome DeleteUser(const Model::DeleteUserRequest& request) const; /** - *

    Deletes the user belonging to the server you specify.

    No response - * returns from this operation.

    When you delete a user from a server, - * the user's information is lost.

    See Also:

    Deletes the user belonging to a file transfer protocol-enabled server you + * specify.

    No response returns from this operation.

    When you + * delete a user from a server, the user's information is lost.

    + *

    See Also:

    AWS * API Reference

    * @@ -349,9 +354,10 @@ namespace Model virtual Model::DeleteUserOutcomeCallable DeleteUserCallable(const Model::DeleteUserRequest& request) const; /** - *

    Deletes the user belonging to the server you specify.

    No response - * returns from this operation.

    When you delete a user from a server, - * the user's information is lost.

    See Also:

    Deletes the user belonging to a file transfer protocol-enabled server you + * specify.

    No response returns from this operation.

    When you + * delete a user from a server, the user's information is lost.

    + *

    See Also:

    AWS * API Reference

    * @@ -360,20 +366,22 @@ namespace Model virtual void DeleteUserAsync(const Model::DeleteUserRequest& request, const DeleteUserResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Describes the server that you specify by passing the ServerId - * parameter.

    The response contains a description of the server's - * properties. When you set EndpointType to VPC, the response will - * contain the EndpointDetails.

    See Also:

    Describes a file transfer protocol-enabled server that you specify by passing + * the ServerId parameter.

    The response contains a description + * of a server's properties. When you set EndpointType to VPC, the + * response will contain the EndpointDetails.

    See Also:

    + *     AWS * API Reference

    */ virtual Model::DescribeServerOutcome DescribeServer(const Model::DescribeServerRequest& request) const; /** - *

    Describes the server that you specify by passing the ServerId - * parameter.

    The response contains a description of the server's - * properties. When you set EndpointType to VPC, the response will - * contain the EndpointDetails.

    See Also:

    Describes a file transfer protocol-enabled server that you specify by passing + * the ServerId parameter.

    The response contains a description + * of a server's properties. When you set EndpointType to VPC, the + * response will contain the EndpointDetails.

    See Also:

    + *     AWS * API Reference

    * @@ -382,10 +390,11 @@ namespace Model virtual Model::DescribeServerOutcomeCallable DescribeServerCallable(const Model::DescribeServerRequest& request) const; /** - *

    Describes the server that you specify by passing the ServerId - * parameter.

    The response contains a description of the server's - * properties. When you set EndpointType to VPC, the response will - * contain the EndpointDetails.

    See Also:

    Describes a file transfer protocol-enabled server that you specify by passing + * the ServerId parameter.

    The response contains a description + * of a server's properties. When you set EndpointType to VPC, the + * response will contain the EndpointDetails.

    See Also:

    + *     AWS * API Reference

    * @@ -394,20 +403,20 @@ namespace Model virtual void DescribeServerAsync(const Model::DescribeServerRequest& request, const DescribeServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Describes the user assigned to a specific server, as identified by its - * ServerId property.

    The response from this call returns the - * properties of the user associated with the ServerId value that was - * specified.

    See Also:

    Describes the user assigned to the specific file transfer protocol-enabled + * server, as identified by its ServerId property.

    The response + * from this call returns the properties of the user associated with the + * ServerId value that was specified.

    See Also:

    AWS * API Reference

    */ virtual Model::DescribeUserOutcome DescribeUser(const Model::DescribeUserRequest& request) const; /** - *

    Describes the user assigned to a specific server, as identified by its - * ServerId property.

    The response from this call returns the - * properties of the user associated with the ServerId value that was - * specified.

    See Also:

    Describes the user assigned to the specific file transfer protocol-enabled + * server, as identified by its ServerId property.

    The response + * from this call returns the properties of the user associated with the + * ServerId value that was specified.

    See Also:

    AWS * API Reference

    * @@ -416,10 +425,10 @@ namespace Model virtual Model::DescribeUserOutcomeCallable DescribeUserCallable(const Model::DescribeUserRequest& request) const; /** - *

    Describes the user assigned to a specific server, as identified by its - * ServerId property.

    The response from this call returns the - * properties of the user associated with the ServerId value that was - * specified.

    See Also:

    Describes the user assigned to the specific file transfer protocol-enabled + * server, as identified by its ServerId property.

    The response + * from this call returns the properties of the user associated with the + * ServerId value that was specified.

    See Also:

    AWS * API Reference

    * @@ -429,10 +438,11 @@ namespace Model /** *

    Adds a Secure Shell (SSH) public key to a user account identified by a - * UserName value assigned to a specific server, identified by - * ServerId.

    The response returns the UserName - * value, the ServerId value, and the name of the - * SshPublicKeyId.

    See Also:

    UserName value assigned to the specific file transfer + * protocol-enabled server, identified by ServerId.

    The + * response returns the UserName value, the ServerId + * value, and the name of the SshPublicKeyId.

    See Also:

    + *     AWS * API Reference

    */ @@ -440,10 +450,11 @@ namespace Model /** *

    Adds a Secure Shell (SSH) public key to a user account identified by a - * UserName value assigned to a specific server, identified by - * ServerId.

    The response returns the UserName - * value, the ServerId value, and the name of the - * SshPublicKeyId.

    See Also:

    UserName value assigned to the specific file transfer + * protocol-enabled server, identified by ServerId.

    The + * response returns the UserName value, the ServerId + * value, and the name of the SshPublicKeyId.

    See Also:

    + *     AWS * API Reference

    * @@ -453,10 +464,11 @@ namespace Model /** *

    Adds a Secure Shell (SSH) public key to a user account identified by a - * UserName value assigned to a specific server, identified by - * ServerId.

    The response returns the UserName - * value, the ServerId value, and the name of the - * SshPublicKeyId.

    See Also:

    UserName value assigned to the specific file transfer + * protocol-enabled server, identified by ServerId.

    The + * response returns the UserName value, the ServerId + * value, and the name of the SshPublicKeyId.

    See Also:

    + *     AWS * API Reference

    * @@ -465,16 +477,16 @@ namespace Model virtual void ImportSshPublicKeyAsync(const Model::ImportSshPublicKeyRequest& request, const ImportSshPublicKeyResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Lists the Secure File Transfer Protocol (SFTP) servers that are associated - * with your AWS account.

    See Also:

    Lists the file transfer protocol-enabled servers that are associated with + * your AWS account.

    See Also:

    AWS * API Reference

    */ virtual Model::ListServersOutcome ListServers(const Model::ListServersRequest& request) const; /** - *

    Lists the Secure File Transfer Protocol (SFTP) servers that are associated - * with your AWS account.

    See Also:

    Lists the file transfer protocol-enabled servers that are associated with + * your AWS account.

    See Also:

    AWS * API Reference

    * @@ -483,8 +495,8 @@ namespace Model virtual Model::ListServersOutcomeCallable ListServersCallable(const Model::ListServersRequest& request) const; /** - *

    Lists the Secure File Transfer Protocol (SFTP) servers that are associated - * with your AWS account.

    See Also:

    Lists the file transfer protocol-enabled servers that are associated with + * your AWS account.

    See Also:

    AWS * API Reference

    * @@ -524,16 +536,16 @@ namespace Model virtual void ListTagsForResourceAsync(const Model::ListTagsForResourceRequest& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Lists the users for the server that you specify by passing the - * ServerId parameter.

    See Also:

    Lists the users for a file transfer protocol-enabled server that you specify + * by passing the ServerId parameter.

    See Also:

    AWS * API Reference

    */ virtual Model::ListUsersOutcome ListUsers(const Model::ListUsersRequest& request) const; /** - *

    Lists the users for the server that you specify by passing the - * ServerId parameter.

    See Also:

    Lists the users for a file transfer protocol-enabled server that you specify + * by passing the ServerId parameter.

    See Also:

    AWS * API Reference

    * @@ -542,8 +554,8 @@ namespace Model virtual Model::ListUsersOutcomeCallable ListUsersCallable(const Model::ListUsersRequest& request) const; /** - *

    Lists the users for the server that you specify by passing the - * ServerId parameter.

    See Also:

    Lists the users for a file transfer protocol-enabled server that you specify + * by passing the ServerId parameter.

    See Also:

    AWS * API Reference

    * @@ -552,28 +564,28 @@ namespace Model virtual void ListUsersAsync(const Model::ListUsersRequest& request, const ListUsersResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Changes the state of a Secure File Transfer Protocol (SFTP) server from - * OFFLINE to ONLINE. It has no impact on an SFTP server - * that is already ONLINE. An ONLINE server can accept - * and process file transfer jobs.

    The state of STARTING - * indicates that the server is in an intermediate state, either not fully able to - * respond, or not fully online. The values of START_FAILED can - * indicate an error condition.

    No response is returned from this - * call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * OFFLINE to ONLINE. It has no impact on a server that + * is already ONLINE. An ONLINE server can accept and + * process file transfer jobs.

    The state of STARTING indicates + * that the server is in an intermediate state, either not fully able to respond, + * or not fully online. The values of START_FAILED can indicate an + * error condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    */ virtual Model::StartServerOutcome StartServer(const Model::StartServerRequest& request) const; /** - *

    Changes the state of a Secure File Transfer Protocol (SFTP) server from - * OFFLINE to ONLINE. It has no impact on an SFTP server - * that is already ONLINE. An ONLINE server can accept - * and process file transfer jobs.

    The state of STARTING - * indicates that the server is in an intermediate state, either not fully able to - * respond, or not fully online. The values of START_FAILED can - * indicate an error condition.

    No response is returned from this - * call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * OFFLINE to ONLINE. It has no impact on a server that + * is already ONLINE. An ONLINE server can accept and + * process file transfer jobs.

    The state of STARTING indicates + * that the server is in an intermediate state, either not fully able to respond, + * or not fully online. The values of START_FAILED can indicate an + * error condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    * @@ -582,14 +594,14 @@ namespace Model virtual Model::StartServerOutcomeCallable StartServerCallable(const Model::StartServerRequest& request) const; /** - *

    Changes the state of a Secure File Transfer Protocol (SFTP) server from - * OFFLINE to ONLINE. It has no impact on an SFTP server - * that is already ONLINE. An ONLINE server can accept - * and process file transfer jobs.

    The state of STARTING - * indicates that the server is in an intermediate state, either not fully able to - * respond, or not fully online. The values of START_FAILED can - * indicate an error condition.

    No response is returned from this - * call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * OFFLINE to ONLINE. It has no impact on a server that + * is already ONLINE. An ONLINE server can accept and + * process file transfer jobs.

    The state of STARTING indicates + * that the server is in an intermediate state, either not fully able to respond, + * or not fully online. The values of START_FAILED can indicate an + * error condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    * @@ -598,30 +610,32 @@ namespace Model virtual void StartServerAsync(const Model::StartServerRequest& request, const StartServerResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Changes the state of an SFTP server from ONLINE to - * OFFLINE. An OFFLINE server cannot accept and process - * file transfer jobs. Information tied to your server such as server and user - * properties are not affected by stopping your server. Stopping a server will not - * reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

    - *

    The state of STOPPING indicates that the server is in an - * intermediate state, either not fully able to respond, or not fully offline. The - * values of STOP_FAILED can indicate an error condition.

    No - * response is returned from this call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * ONLINE to OFFLINE. An OFFLINE server + * cannot accept and process file transfer jobs. Information tied to your server, + * such as server and user properties, are not affected by stopping your server. + * Stopping the server will not reduce or impact your file transfer protocol + * endpoint billing.

    The state of STOPPING indicates that the + * server is in an intermediate state, either not fully able to respond, or not + * fully offline. The values of STOP_FAILED can indicate an error + * condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    */ virtual Model::StopServerOutcome StopServer(const Model::StopServerRequest& request) const; /** - *

    Changes the state of an SFTP server from ONLINE to - * OFFLINE. An OFFLINE server cannot accept and process - * file transfer jobs. Information tied to your server such as server and user - * properties are not affected by stopping your server. Stopping a server will not - * reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

    - *

    The state of STOPPING indicates that the server is in an - * intermediate state, either not fully able to respond, or not fully offline. The - * values of STOP_FAILED can indicate an error condition.

    No - * response is returned from this call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * ONLINE to OFFLINE. An OFFLINE server + * cannot accept and process file transfer jobs. Information tied to your server, + * such as server and user properties, are not affected by stopping your server. + * Stopping the server will not reduce or impact your file transfer protocol + * endpoint billing.

    The state of STOPPING indicates that the + * server is in an intermediate state, either not fully able to respond, or not + * fully offline. The values of STOP_FAILED can indicate an error + * condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    * @@ -630,15 +644,16 @@ namespace Model virtual Model::StopServerOutcomeCallable StopServerCallable(const Model::StopServerRequest& request) const; /** - *

    Changes the state of an SFTP server from ONLINE to - * OFFLINE. An OFFLINE server cannot accept and process - * file transfer jobs. Information tied to your server such as server and user - * properties are not affected by stopping your server. Stopping a server will not - * reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

    - *

    The state of STOPPING indicates that the server is in an - * intermediate state, either not fully able to respond, or not fully offline. The - * values of STOP_FAILED can indicate an error condition.

    No - * response is returned from this call.

    See Also:

    Changes the state of a file transfer protocol-enabled server from + * ONLINE to OFFLINE. An OFFLINE server + * cannot accept and process file transfer jobs. Information tied to your server, + * such as server and user properties, are not affected by stopping your server. + * Stopping the server will not reduce or impact your file transfer protocol + * endpoint billing.

    The state of STOPPING indicates that the + * server is in an intermediate state, either not fully able to respond, or not + * fully offline. The values of STOP_FAILED can indicate an error + * condition.

    No response is returned from this call.

    See + * Also:

    AWS * API Reference

    * @@ -678,24 +693,24 @@ namespace Model virtual void TagResourceAsync(const Model::TagResourceRequest& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    If the IdentityProviderType of the server is - * API_Gateway, tests whether your API Gateway is set up successfully. - * We highly recommend that you call this operation to test your authentication - * method as soon as you create your server. By doing so, you can troubleshoot - * issues with the API Gateway integration to ensure that your users can - * successfully use the service.

    See Also:

    If the IdentityProviderType of a file transfer protocol-enabled + * server is API_Gateway, tests whether your API Gateway is set up + * successfully. We highly recommend that you call this operation to test your + * authentication method as soon as you create your server. By doing so, you can + * troubleshoot issues with the API Gateway integration to ensure that your users + * can successfully use the service.

    See Also:

    AWS * API Reference

    */ virtual Model::TestIdentityProviderOutcome TestIdentityProvider(const Model::TestIdentityProviderRequest& request) const; /** - *

    If the IdentityProviderType of the server is - * API_Gateway, tests whether your API Gateway is set up successfully. - * We highly recommend that you call this operation to test your authentication - * method as soon as you create your server. By doing so, you can troubleshoot - * issues with the API Gateway integration to ensure that your users can - * successfully use the service.

    See Also:

    If the IdentityProviderType of a file transfer protocol-enabled + * server is API_Gateway, tests whether your API Gateway is set up + * successfully. We highly recommend that you call this operation to test your + * authentication method as soon as you create your server. By doing so, you can + * troubleshoot issues with the API Gateway integration to ensure that your users + * can successfully use the service.

    See Also:

    AWS * API Reference

    * @@ -704,12 +719,12 @@ namespace Model virtual Model::TestIdentityProviderOutcomeCallable TestIdentityProviderCallable(const Model::TestIdentityProviderRequest& request) const; /** - *

    If the IdentityProviderType of the server is - * API_Gateway, tests whether your API Gateway is set up successfully. - * We highly recommend that you call this operation to test your authentication - * method as soon as you create your server. By doing so, you can troubleshoot - * issues with the API Gateway integration to ensure that your users can - * successfully use the service.

    See Also:

    If the IdentityProviderType of a file transfer protocol-enabled + * server is API_Gateway, tests whether your API Gateway is set up + * successfully. We highly recommend that you call this operation to test your + * authentication method as soon as you create your server. By doing so, you can + * troubleshoot issues with the API Gateway integration to ensure that your users + * can successfully use the service.

    See Also:

    AWS * API Reference

    * @@ -752,18 +767,18 @@ namespace Model virtual void UntagResourceAsync(const Model::UntagResourceRequest& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

    Updates the server properties after that server has been created.

    The - * UpdateServer call returns the ServerId of the Secure - * File Transfer Protocol (SFTP) server you updated.

    See Also:

    Updates the file transfer protocol-enabled server's properties after that + * server has been created.

    The UpdateServer call returns the + * ServerId of the server you updated.

    See Also:

    AWS * API Reference

    */ virtual Model::UpdateServerOutcome UpdateServer(const Model::UpdateServerRequest& request) const; /** - *

    Updates the server properties after that server has been created.

    The - * UpdateServer call returns the ServerId of the Secure - * File Transfer Protocol (SFTP) server you updated.

    See Also:

    Updates the file transfer protocol-enabled server's properties after that + * server has been created.

    The UpdateServer call returns the + * ServerId of the server you updated.

    See Also:

    AWS * API Reference

    * @@ -772,9 +787,9 @@ namespace Model virtual Model::UpdateServerOutcomeCallable UpdateServerCallable(const Model::UpdateServerRequest& request) const; /** - *

    Updates the server properties after that server has been created.

    The - * UpdateServer call returns the ServerId of the Secure - * File Transfer Protocol (SFTP) server you updated.

    See Also:

    Updates the file transfer protocol-enabled server's properties after that + * server has been created.

    The UpdateServer call returns the + * ServerId of the server you updated.

    See Also:

    AWS * API Reference

    * diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerRequest.h index d734a7a6918..4c72ba6c335 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerRequest.h @@ -16,12 +16,13 @@ #pragma once #include #include +#include #include #include -#include #include #include #include +#include #include #include @@ -50,106 +51,163 @@ namespace Model Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline const Aws::String& GetCertificate() const{ return m_certificate; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const Aws::String& value) { m_certificateHasBeenSet = true; m_certificate = value; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(Aws::String&& value) { m_certificateHasBeenSet = true; m_certificate = std::move(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const char* value) { m_certificateHasBeenSet = true; m_certificate.assign(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline CreateServerRequest& WithCertificate(const Aws::String& value) { SetCertificate(value); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline CreateServerRequest& WithCertificate(Aws::String&& value) { SetCertificate(std::move(value)); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline CreateServerRequest& WithCertificate(const char* value) { SetCertificate(value); return *this;} + + /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline const EndpointDetails& GetEndpointDetails() const{ return m_endpointDetails; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline void SetEndpointDetails(const EndpointDetails& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = value; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline void SetEndpointDetails(EndpointDetails&& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = std::move(value); } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline CreateServerRequest& WithEndpointDetails(const EndpointDetails& value) { SetEndpointDetails(value); return *this;} /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to invoke the UpdateServer API and attach an Elastic - * IP to your server's endpoint.

    + * your file transfer protocol-enabled server. When you host your endpoint within + * your VPC, you can make it accessible only to resources within your VPC, or you + * can attach Elastic IPs and make it accessible to clients over the internet. Your + * VPC's default security groups are automatically assigned to your endpoint.

    */ inline CreateServerRequest& WithEndpointDetails(EndpointDetails&& value) { SetEndpointDetails(std::move(value)); return *this;} /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline const EndpointType& GetEndpointType() const{ return m_endpointType; } /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; } /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline void SetEndpointType(const EndpointType& value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; } /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline void SetEndpointType(EndpointType&& value) { m_endpointTypeHasBeenSet = true; m_endpointType = std::move(value); } /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline CreateServerRequest& WithEndpointType(const EndpointType& value) { SetEndpointType(value); return *this;} /** - *

    The type of VPC endpoint that you want your SFTP server to connect to. You - * can choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, you can restrict access to your SFTP server and - * resources only within your VPC.

    + *

    The type of VPC endpoint that you want your file transfer protocol-enabled + * server to connect to. You can choose to connect to the public internet or a + * virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict + * access to your server and resources only within your VPC.

    */ inline CreateServerRequest& WithEndpointType(EndpointType&& value) { SetEndpointType(std::move(value)); return *this;} @@ -157,305 +215,405 @@ namespace Model /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline const Aws::String& GetHostKey() const{ return m_hostKey; } /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; } /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(const Aws::String& value) { m_hostKeyHasBeenSet = true; m_hostKey = value; } /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(Aws::String&& value) { m_hostKeyHasBeenSet = true; m_hostKey = std::move(value); } /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(const char* value) { m_hostKeyHasBeenSet = true; m_hostKey.assign(value); } /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline CreateServerRequest& WithHostKey(const Aws::String& value) { SetHostKey(value); return *this;} /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline CreateServerRequest& WithHostKey(Aws::String&& value) { SetHostKey(std::move(value)); return *this;} /** *

    The RSA private key as generated by the ssh-keygen -N "" -f * my-new-server-key command.

    If you aren't planning to - * migrate existing users from an existing SFTP server to a new AWS SFTP server, + * migrate existing users from an existing SFTP-enabled server to a new server, * don't update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline CreateServerRequest& WithHostKey(const char* value) { SetHostKey(value); return *this;} /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline const IdentityProviderDetails& GetIdentityProviderDetails() const{ return m_identityProviderDetails; } /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; } /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline void SetIdentityProviderDetails(const IdentityProviderDetails& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = value; } /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline void SetIdentityProviderDetails(IdentityProviderDetails&& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = std::move(value); } /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline CreateServerRequest& WithIdentityProviderDetails(const IdentityProviderDetails& value) { SetIdentityProviderDetails(value); return *this;} /** - *

    This parameter is required when the IdentityProviderType is set - * to API_GATEWAY. Accepts an array containing all of the information + *

    Required when IdentityProviderType is set to + * API_GATEWAY. Accepts an array containing all of the information * required to call a customer-supplied authentication API, including the API - * Gateway URL. This property is not required when the - * IdentityProviderType is set to SERVICE_MANAGED.

    + * Gateway URL. Not required when IdentityProviderType is set to + * SERVICE_MANAGED.

    */ inline CreateServerRequest& WithIdentityProviderDetails(IdentityProviderDetails&& value) { SetIdentityProviderDetails(std::move(value)); return *this;} /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline const IdentityProviderType& GetIdentityProviderType() const{ return m_identityProviderType; } /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; } /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline void SetIdentityProviderType(const IdentityProviderType& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = value; } /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline void SetIdentityProviderType(IdentityProviderType&& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = std::move(value); } /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline CreateServerRequest& WithIdentityProviderType(const IdentityProviderType& value) { SetIdentityProviderType(value); return *this;} /** - *

    Specifies the mode of authentication for the SFTP server. The default value - * is SERVICE_MANAGED, which allows you to store and access SFTP user - * credentials within the AWS Transfer for SFTP service. Use the - * API_GATEWAY value to integrate with an identity provider of your - * choosing. The API_GATEWAY setting requires you to provide an API - * Gateway endpoint URL to call for authentication using the + *

    Specifies the mode of authentication for a file transfer protocol-enabled + * server. The default value is SERVICE_MANAGED, which allows you to + * store and access user credentials within the AWS Transfer Family service. Use + * the API_GATEWAY value to integrate with an identity provider of + * your choosing. The API_GATEWAY setting requires you to provide an + * API Gateway endpoint URL to call for authentication using the * IdentityProviderDetails parameter.

    */ inline CreateServerRequest& WithIdentityProviderType(IdentityProviderType&& value) { SetIdentityProviderType(std::move(value)); return *this;} /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline const Aws::String& GetLoggingRole() const{ return m_loggingRole; } /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; } /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline void SetLoggingRole(const Aws::String& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = value; } /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline void SetLoggingRole(Aws::String&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::move(value); } /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline void SetLoggingRole(const char* value) { m_loggingRoleHasBeenSet = true; m_loggingRole.assign(value); } /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline CreateServerRequest& WithLoggingRole(const Aws::String& value) { SetLoggingRole(value); return *this;} /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline CreateServerRequest& WithLoggingRole(Aws::String&& value) { SetLoggingRole(std::move(value)); return *this;} /** - *

    A value that allows the service to write your SFTP users' activity to your - * Amazon CloudWatch logs for monitoring and auditing purposes.

    + *

    Allows the service to write your users' activity to your Amazon CloudWatch + * logs for monitoring and auditing purposes.

    */ inline CreateServerRequest& WithLoggingRole(const char* value) { SetLoggingRole(value); return *this;} /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline const Aws::Vector& GetProtocols() const{ return m_protocols; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(const Aws::Vector& value) { m_protocolsHasBeenSet = true; m_protocols = value; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(Aws::Vector&& value) { m_protocolsHasBeenSet = true; m_protocols = std::move(value); } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline CreateServerRequest& WithProtocols(const Aws::Vector& value) { SetProtocols(value); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline CreateServerRequest& WithProtocols(Aws::Vector&& value) { SetProtocols(std::move(value)); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline CreateServerRequest& AddProtocols(const Protocol& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(value); return *this; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline CreateServerRequest& AddProtocols(Protocol&& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(std::move(value)); return *this; } + + + /** + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline const Aws::Vector& GetTags() const{ return m_tags; } /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline CreateServerRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline CreateServerRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline CreateServerRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** - *

    Key-value pairs that can be used to group and search for servers.

    + *

    Key-value pairs that can be used to group and search for file transfer + * protocol-enabled servers.

    */ inline CreateServerRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: + Aws::String m_certificate; + bool m_certificateHasBeenSet; + EndpointDetails m_endpointDetails; bool m_endpointDetailsHasBeenSet; @@ -474,6 +632,9 @@ namespace Model Aws::String m_loggingRole; bool m_loggingRoleHasBeenSet; + Aws::Vector m_protocols; + bool m_protocolsHasBeenSet; + Aws::Vector m_tags; bool m_tagsHasBeenSet; }; diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerResult.h index cc74af95fd4..209b1cd7ba0 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateServerResult.h @@ -43,37 +43,44 @@ namespace Model /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline CreateServerResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline CreateServerResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    The service-assigned ID of the SFTP server that is created.

    + *

    The service-assigned ID of the file transfer protocol-enabled server that is + * created.

    */ inline CreateServerResult& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserRequest.h index 1510944d1fb..cea6876aea7 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserRequest.h @@ -49,304 +49,312 @@ namespace Model /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline CreateUserRequest& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline CreateUserRequest& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** - *

    The landing directory (folder) for a user when they log in to the server - * using their SFTP client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    The landing directory (folder) for a user when they log in to the file + * transfer protocol-enabled server using the client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline CreateUserRequest& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline CreateUserRequest& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP server. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline CreateUserRequest& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline const Aws::Vector& GetHomeDirectoryMappings() const{ return m_homeDirectoryMappings; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline bool HomeDirectoryMappingsHasBeenSet() const { return m_homeDirectoryMappingsHasBeenSet; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline void SetHomeDirectoryMappings(const Aws::Vector& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = value; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline void SetHomeDirectoryMappings(Aws::Vector&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = std::move(value); } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline CreateUserRequest& WithHomeDirectoryMappings(const Aws::Vector& value) { SetHomeDirectoryMappings(value); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline CreateUserRequest& WithHomeDirectoryMappings(Aws::Vector&& value) { SetHomeDirectoryMappings(std::move(value)); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline CreateUserRequest& AddHomeDirectoryMappings(const HomeDirectoryMapEntry& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(value); return *this; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a '/' for it to be considered a + * folder.

     */ inline CreateUserRequest& AddHomeDirectoryMappings(HomeDirectoryMapEntry&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(std::move(value)); return *this; } @@ -357,14 +365,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline const Aws::String& GetPolicy() const{ return m_policy; } @@ -374,14 +382,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } @@ -391,14 +399,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } @@ -408,14 +416,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } @@ -425,14 +433,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } @@ -442,14 +450,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline CreateUserRequest& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;} @@ -459,14 +467,14 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline CreateUserRequest& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;} @@ -476,193 +484,193 @@ namespace Model * S3 bucket. Variables that you can use inside this policy include * ${Transfer:UserName}, ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline CreateUserRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline const Aws::String& GetRole() const{ return m_role; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline CreateUserRequest& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline CreateUserRequest& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the SFTP server to access your resources when servicing your SFTP user's - * transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline CreateUserRequest& WithRole(const char* value) { SetRole(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline CreateUserRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline CreateUserRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance. This is the - * specific SFTP server that you added your user to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance. This is the specific server that you added your user to.

    */ inline CreateUserRequest& WithServerId(const char* value) { SetServerId(value); return *this;} /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline const Aws::String& GetSshPublicKeyBody() const{ return m_sshPublicKeyBody; } /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline bool SshPublicKeyBodyHasBeenSet() const { return m_sshPublicKeyBodyHasBeenSet; } /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline void SetSshPublicKeyBody(const Aws::String& value) { m_sshPublicKeyBodyHasBeenSet = true; m_sshPublicKeyBody = value; } /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline void SetSshPublicKeyBody(Aws::String&& value) { m_sshPublicKeyBodyHasBeenSet = true; m_sshPublicKeyBody = std::move(value); } /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline void SetSshPublicKeyBody(const char* value) { m_sshPublicKeyBodyHasBeenSet = true; m_sshPublicKeyBody.assign(value); } /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline CreateUserRequest& WithSshPublicKeyBody(const Aws::String& value) { SetSshPublicKeyBody(value); return *this;} /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline CreateUserRequest& WithSshPublicKeyBody(Aws::String&& value) { SetSshPublicKeyBody(std::move(value)); return *this;} /** *

    The public portion of the Secure Shell (SSH) key used to authenticate the - * user to the SFTP server.

    + * user to the file transfer protocol-enabled server.

    */ inline CreateUserRequest& WithSshPublicKeyBody(const char* value) { SetSshPublicKeyBody(value); return *this;} @@ -717,66 +725,74 @@ namespace Model /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline CreateUserRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline CreateUserRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This user name must be a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This user + * name must be a minimum of 3 and a maximum of 32 characters long. The following + * are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline CreateUserRequest& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserResult.h index 29fafd95b86..3185ede6409 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/CreateUserResult.h @@ -43,80 +43,87 @@ namespace Model /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline CreateUserResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline CreateUserResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    The ID of the SFTP server that the user is attached to.

    + *

    The ID of the file transfer protocol-enabled server that the user is attached + * to.

    */ inline CreateUserResult& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline void SetUserName(const Aws::String& value) { m_userName = value; } /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline void SetUserName(Aws::String&& value) { m_userName = std::move(value); } /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline void SetUserName(const char* value) { m_userName.assign(value); } /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline CreateUserResult& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline CreateUserResult& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    A unique string that identifies a user account associated with an SFTP - * server.

    + *

    A unique string that identifies a user account associated with a file + * transfer protocol-enabled server.

    */ inline CreateUserResult& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteServerRequest.h index e88631c39bc..1c7586625bd 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteServerRequest.h @@ -45,42 +45,50 @@ namespace Model /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline DeleteServerRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline DeleteServerRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A unique system-assigned identifier for an SFTP server instance.

    + *

    A unique system-assigned identifier for a file transfer protocol-enabled + * server instance.

    */ inline DeleteServerRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteSshPublicKeyRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteSshPublicKeyRequest.h index a08299906ff..371c5e9cf84 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteSshPublicKeyRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteSshPublicKeyRequest.h @@ -45,50 +45,50 @@ namespace Model /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteSshPublicKeyRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteSshPublicKeyRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server instance that has the user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteSshPublicKeyRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteUserRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteUserRequest.h index 0fcaaa2171f..fcebef8ed36 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteUserRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DeleteUserRequest.h @@ -45,99 +45,99 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteUserRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteUserRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that has the - * user assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that has the user assigned to it.

    */ inline DeleteUserRequest& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline DeleteUserRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline DeleteUserRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    A unique string that identifies a user that is being deleted from the - * server.

    + *

    A unique string that identifies a user that is being deleted from a file + * transfer protocol-enabled server.

    */ inline DeleteUserRequest& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerRequest.h index fc38a67431b..47777cd3fba 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerRequest.h @@ -45,42 +45,50 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline DescribeServerRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline DescribeServerRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline DescribeServerRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerResult.h index dbd2d193a73..fdcd53fcae7 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeServerResult.h @@ -43,32 +43,32 @@ namespace Model /** - *

    An array containing the properties of the server with the - * ServerID you specified.

    + *

    An array containing the properties of a file transfer protocol-enabled server + * with the ServerID you specified.

    */ inline const DescribedServer& GetServer() const{ return m_server; } /** - *

    An array containing the properties of the server with the - * ServerID you specified.

    + *

    An array containing the properties of a file transfer protocol-enabled server + * with the ServerID you specified.

    */ inline void SetServer(const DescribedServer& value) { m_server = value; } /** - *

    An array containing the properties of the server with the - * ServerID you specified.

    + *

    An array containing the properties of a file transfer protocol-enabled server + * with the ServerID you specified.

    */ inline void SetServer(DescribedServer&& value) { m_server = std::move(value); } /** - *

    An array containing the properties of the server with the - * ServerID you specified.

    + *

    An array containing the properties of a file transfer protocol-enabled server + * with the ServerID you specified.

    */ inline DescribeServerResult& WithServer(const DescribedServer& value) { SetServer(value); return *this;} /** - *

    An array containing the properties of the server with the - * ServerID you specified.

    + *

    An array containing the properties of a file transfer protocol-enabled server + * with the ServerID you specified.

    */ inline DescribeServerResult& WithServer(DescribedServer&& value) { SetServer(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserRequest.h index e48471147b6..90f19e4b211 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserRequest.h @@ -45,107 +45,107 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserRequest& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline DescribeUserRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline DescribeUserRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    The name of the user assigned to one or more servers. User names are part of - * the sign-in credentials to use the AWS Transfer for SFTP service and perform - * file transfer tasks.

    + *

    The name of the user assigned to one or more file transfer protocol-enabled + * servers. User names are part of the sign-in credentials to use the AWS Transfer + * Family service and perform file transfer tasks.

    */ inline DescribeUserRequest& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserResult.h index 4664fad26a5..1dfc2c56c4c 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribeUserResult.h @@ -44,44 +44,44 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that has this user - * assigned.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has this user assigned.

    */ inline DescribeUserResult& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedServer.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedServer.h index d3079637a64..2bd190f706d 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedServer.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedServer.h @@ -20,8 +20,9 @@ #include #include #include -#include #include +#include +#include #include #include @@ -41,10 +42,11 @@ namespace Model { /** - *

    Describes the properties of the server that was specified. Information - * returned includes the following: the server Amazon Resource Name (ARN), the - * authentication configuration and type, the logging role, the server ID and - * state, and assigned tags or metadata.

    See Also:

    Describes the properties of a file transfer protocol-enabled server that was + * specified. Information returned includes the following: the server Amazon + * Resource Name (ARN), the authentication configuration and type, the logging + * role, the server ID and state, and assigned tags or metadata.

    See + * Also:

    AWS * API Reference

    */ @@ -58,538 +60,690 @@ namespace Model /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline DescribedServer& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline DescribedServer& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    Specifies the unique Amazon Resource Name (ARN) for the server to be - * described.

    + *

    Specifies the unique Amazon Resource Name (ARN) for a file transfer + * protocol-enabled server to be described.

    */ inline DescribedServer& WithArn(const char* value) { SetArn(value); return *this;} + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline const Aws::String& GetCertificate() const{ return m_certificate; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const Aws::String& value) { m_certificateHasBeenSet = true; m_certificate = value; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(Aws::String&& value) { m_certificateHasBeenSet = true; m_certificate = std::move(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const char* value) { m_certificateHasBeenSet = true; m_certificate.assign(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline DescribedServer& WithCertificate(const Aws::String& value) { SetCertificate(value); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline DescribedServer& WithCertificate(Aws::String&& value) { SetCertificate(std::move(value)); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline DescribedServer& WithCertificate(const char* value) { SetCertificate(value); return *this;} + + /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline const EndpointDetails& GetEndpointDetails() const{ return m_endpointDetails; } /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; } /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline void SetEndpointDetails(const EndpointDetails& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = value; } /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline void SetEndpointDetails(EndpointDetails&& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = std::move(value); } /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline DescribedServer& WithEndpointDetails(const EndpointDetails& value) { SetEndpointDetails(value); return *this;} /** *

    The virtual private cloud (VPC) endpoint settings that you configured for - * your SFTP server.

    + * your file transfer protocol-enabled server.

    */ inline DescribedServer& WithEndpointDetails(EndpointDetails&& value) { SetEndpointDetails(std::move(value)); return *this;} /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline const EndpointType& GetEndpointType() const{ return m_endpointType; } /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; } /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline void SetEndpointType(const EndpointType& value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; } /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline void SetEndpointType(EndpointType&& value) { m_endpointTypeHasBeenSet = true; m_endpointType = std::move(value); } /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline DescribedServer& WithEndpointType(const EndpointType& value) { SetEndpointType(value); return *this;} /** - *

    The type of endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline DescribedServer& WithEndpointType(EndpointType&& value) { SetEndpointType(std::move(value)); return *this;} /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline const Aws::String& GetHostKeyFingerprint() const{ return m_hostKeyFingerprint; } /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline bool HostKeyFingerprintHasBeenSet() const { return m_hostKeyFingerprintHasBeenSet; } /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline void SetHostKeyFingerprint(const Aws::String& value) { m_hostKeyFingerprintHasBeenSet = true; m_hostKeyFingerprint = value; } /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline void SetHostKeyFingerprint(Aws::String&& value) { m_hostKeyFingerprintHasBeenSet = true; m_hostKeyFingerprint = std::move(value); } /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline void SetHostKeyFingerprint(const char* value) { m_hostKeyFingerprintHasBeenSet = true; m_hostKeyFingerprint.assign(value); } /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline DescribedServer& WithHostKeyFingerprint(const Aws::String& value) { SetHostKeyFingerprint(value); return *this;} /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline DescribedServer& WithHostKeyFingerprint(Aws::String&& value) { SetHostKeyFingerprint(std::move(value)); return *this;} /** - *

    This value contains the message-digest algorithm (MD5) hash of the server's - * host key. This value is equivalent to the output of the ssh-keygen -l -E - * md5 -f my-new-server-key command.

    + *

    Contains the message-digest algorithm (MD5) hash of a file transfer + * protocol-enabled server's host key. This value is equivalent to the output of + * the ssh-keygen -l -E md5 -f my-new-server-key command.

    */ inline DescribedServer& WithHostKeyFingerprint(const char* value) { SetHostKeyFingerprint(value); return *this;} /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline const IdentityProviderDetails& GetIdentityProviderDetails() const{ return m_identityProviderDetails; } /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; } /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline void SetIdentityProviderDetails(const IdentityProviderDetails& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = value; } /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline void SetIdentityProviderDetails(IdentityProviderDetails&& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = std::move(value); } /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline DescribedServer& WithIdentityProviderDetails(const IdentityProviderDetails& value) { SetIdentityProviderDetails(value); return *this;} /** *

    Specifies information to call a customer-supplied authentication API. This - * field is not populated when the IdentityProviderType of the server - * is SERVICE_MANAGED>.

    + * field is not populated when the IdentityProviderType of a file + * transfer protocol-enabled server is SERVICE_MANAGED.

    */ inline DescribedServer& WithIdentityProviderDetails(IdentityProviderDetails&& value) { SetIdentityProviderDetails(std::move(value)); return *this;} /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline const IdentityProviderType& GetIdentityProviderType() const{ return m_identityProviderType; } /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; } /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline void SetIdentityProviderType(const IdentityProviderType& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = value; } /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline void SetIdentityProviderType(IdentityProviderType&& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = std::move(value); } /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline DescribedServer& WithIdentityProviderType(const IdentityProviderType& value) { SetIdentityProviderType(value); return *this;} /** - *

    This property defines the mode of authentication method enabled for this - * service. A value of SERVICE_MANAGED means that you are using this - * server to store and access SFTP user credentials within the service. A value of - * API_GATEWAY indicates that you have integrated an API Gateway - * endpoint that will be invoked for authenticating your user into the service.

    + *

    Defines the mode of authentication method enabled for this service. A value + * of SERVICE_MANAGED means that you are using this file transfer + * protocol-enabled server to store and access user credentials within the service. + * A value of API_GATEWAY indicates that you have integrated an API + * Gateway endpoint that will be invoked for authenticating your user into the + * service.

    */ inline DescribedServer& WithIdentityProviderType(IdentityProviderType&& value) { SetIdentityProviderType(std::move(value)); return *this;} /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline const Aws::String& GetLoggingRole() const{ return m_loggingRole; } /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; } /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline void SetLoggingRole(const Aws::String& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = value; } /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline void SetLoggingRole(Aws::String&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::move(value); } /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline void SetLoggingRole(const char* value) { m_loggingRoleHasBeenSet = true; m_loggingRole.assign(value); } /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline DescribedServer& WithLoggingRole(const Aws::String& value) { SetLoggingRole(value); return *this;} /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline DescribedServer& WithLoggingRole(Aws::String&& value) { SetLoggingRole(std::move(value)); return *this;} /** - *

    This property is an AWS Identity and Access Management (IAM) entity that - * allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. - * When set, user activity can be viewed in your CloudWatch logs.

    + *

    An AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon + * S3 events. When set, user activity can be viewed in your CloudWatch logs.

    */ inline DescribedServer& WithLoggingRole(const char* value) { SetLoggingRole(value); return *this;} /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline const Aws::Vector& GetProtocols() const{ return m_protocols; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(const Aws::Vector& value) { m_protocolsHasBeenSet = true; m_protocols = value; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(Aws::Vector&& value) { m_protocolsHasBeenSet = true; m_protocols = std::move(value); } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline DescribedServer& WithProtocols(const Aws::Vector& value) { SetProtocols(value); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline DescribedServer& WithProtocols(Aws::Vector&& value) { SetProtocols(std::move(value)); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline DescribedServer& AddProtocols(const Protocol& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(value); return *this; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline DescribedServer& AddProtocols(Protocol&& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(std::move(value)); return *this; } + + + /** + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline DescribedServer& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline DescribedServer& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    This property is a unique system-assigned identifier for the SFTP server that - * you instantiate.

    + *

    Unique system-assigned identifier for a file transfer protocol-enabled server + * that you instantiate.

    */ inline DescribedServer& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline const State& GetState() const{ return m_state; } /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline void SetState(const State& value) { m_stateHasBeenSet = true; m_state = value; } /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline void SetState(State&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline DescribedServer& WithState(const State& value) { SetState(value); return *this;} /** - *

    The condition of the SFTP server for the server that was described. A value - * of ONLINE indicates that the server can accept jobs and transfer - * files. A State value of OFFLINE means that the server - * cannot perform file transfer operations.

    The states of - * STARTING and STOPPING indicate that the server is in - * an intermediate state, either not fully able to respond, or not fully offline. - * The values of START_FAILED or STOP_FAILED can indicate - * an error condition.

    + *

    The condition of a file transfer protocol-enabled server for the server that + * was described. A value of ONLINE indicates that the server can + * accept jobs and transfer files. A State value of + * OFFLINE means that the server cannot perform file transfer + * operations.

    The states of STARTING and STOPPING + * indicate that the server is in an intermediate state, either not fully able to + * respond, or not fully offline. The values of START_FAILED or + * STOP_FAILED can indicate an error condition.

    */ inline DescribedServer& WithState(State&& value) { SetState(std::move(value)); return *this;} /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline const Aws::Vector& GetTags() const{ return m_tags; } /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline DescribedServer& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline DescribedServer& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline DescribedServer& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** - *

    This property contains the key-value pairs that you can use to search for and - * group servers that were assigned to the server that was described.

    + *

    Contains the key-value pairs that you can use to search for and group file + * transfer protocol-enabled servers that were assigned to the server that was + * described.

    */ inline DescribedServer& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** - *

    The number of users that are assigned to the SFTP server you specified with - * the ServerId.

    + *

    The number of users that are assigned to a file transfer protocol-enabled + * server you specified with the ServerId.

    */ inline int GetUserCount() const{ return m_userCount; } /** - *

    The number of users that are assigned to the SFTP server you specified with - * the ServerId.

    + *

    The number of users that are assigned to a file transfer protocol-enabled + * server you specified with the ServerId.

    */ inline bool UserCountHasBeenSet() const { return m_userCountHasBeenSet; } /** - *

    The number of users that are assigned to the SFTP server you specified with - * the ServerId.

    + *

    The number of users that are assigned to a file transfer protocol-enabled + * server you specified with the ServerId.

    */ inline void SetUserCount(int value) { m_userCountHasBeenSet = true; m_userCount = value; } /** - *

    The number of users that are assigned to the SFTP server you specified with - * the ServerId.

    + *

    The number of users that are assigned to a file transfer protocol-enabled + * server you specified with the ServerId.

    */ inline DescribedServer& WithUserCount(int value) { SetUserCount(value); return *this;} @@ -598,6 +752,9 @@ namespace Model Aws::String m_arn; bool m_arnHasBeenSet; + Aws::String m_certificate; + bool m_certificateHasBeenSet; + EndpointDetails m_endpointDetails; bool m_endpointDetailsHasBeenSet; @@ -616,6 +773,9 @@ namespace Model Aws::String m_loggingRole; bool m_loggingRoleHasBeenSet; + Aws::Vector m_protocols; + bool m_protocolsHasBeenSet; + Aws::String m_serverId; bool m_serverIdHasBeenSet; diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedUser.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedUser.h index ec622b02332..8a3d303d0fa 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedUser.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/DescribedUser.h @@ -54,258 +54,226 @@ namespace Model /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline DescribedUser& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline DescribedUser& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    This property contains the unique Amazon Resource Name (ARN) for the user - * that was requested to be described.

    + *

    Contains the unique Amazon Resource Name (ARN) for the user that was + * requested to be described.

    */ inline DescribedUser& WithArn(const char* value) { SetArn(value); return *this;} /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline DescribedUser& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline DescribedUser& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** - *

    This property specifies the landing directory (or folder), which is the - * location that files are written to or read from in an Amazon S3 bucket for the - * described user. An example is /your s3 bucket - * name/home/username .

    + *

    Specifies the landing directory (or folder), which is the location that files + * are written to or read from in an Amazon S3 bucket for the described user. An + * example is /your s3 bucket name/home/username .

    */ inline DescribedUser& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline const Aws::Vector& GetHomeDirectoryMappings() const{ return m_homeDirectoryMappings; } /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline bool HomeDirectoryMappingsHasBeenSet() const { return m_homeDirectoryMappingsHasBeenSet; } /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline void SetHomeDirectoryMappings(const Aws::Vector& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = value; } /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline void SetHomeDirectoryMappings(Aws::Vector&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = std::move(value); } /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline DescribedUser& WithHomeDirectoryMappings(const Aws::Vector& value) { SetHomeDirectoryMappings(value); return *this;} /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline DescribedUser& WithHomeDirectoryMappings(Aws::Vector&& value) { SetHomeDirectoryMappings(std::move(value)); return *this;} /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ inline DescribedUser& AddHomeDirectoryMappings(const HomeDirectoryMapEntry& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(value); return *this; } /** - *

    Logical directory mappings that you specified for what S3 paths and keys - * should be visible to your user and how you want to make them visible. You will - * need to specify the "Entry" and "Target" pair, where - * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target.

    In most cases, you can use this value instead of - * the scope down policy to lock your user down to the designated home directory - * ("chroot"). To do this, you can set Entry to '/' and set - * Target to the HomeDirectory parameter value.

    In most cases, - * you can use this value instead of the scope down policy to lock your user down - * to the designated home directory ("chroot"). To do this, you can set + *

    Logical directory mappings that you specified for what Amazon S3 paths and + * keys should be visible to your user and how you want to make them visible. You + * will need to specify the "Entry" and "Target" pair, + * where Entry shows how the path is made visible and + * Target is the actual Amazon S3 path. If you only specify a target, + * it will be displayed as is. You will need to also make sure that your AWS IAM + * Role provides access to paths in Target.

    In most cases, you + * can use this value instead of the scope-down policy to lock your user down to + * the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory * parameter value.

    */ @@ -313,62 +281,62 @@ namespace Model /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline DescribedUser& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** - *

    The type of landing directory (folder) you mapped for your users' to see when - * they log into the SFTP server. If you set it to PATH, the user will - * see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set - * it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + *

    The type of landing directory (folder) you mapped for your users to see when + * they log into the file transfer protocol-enabled server. If you set it to + * PATH, the user will see the absolute Amazon S3 bucket paths as is + * in their file transfer protocol clients. If you set it LOGICAL, you + * will need to provide mappings in the HomeDirectoryMappings for how + * you want to make Amazon S3 paths visible to your users.

    */ inline DescribedUser& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} @@ -415,237 +383,237 @@ namespace Model /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline const Aws::String& GetRole() const{ return m_role; } /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline DescribedUser& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline DescribedUser& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** - *

    This property specifies the IAM role that controls your user's access to your - * Amazon S3 bucket. The policies attached to this role will determine the level of - * access you want to provide your users when transferring files into and out of - * your Amazon S3 bucket or buckets. The IAM role should also contain a trust - * relationship that allows the SFTP server to access your resources when servicing - * your SFTP user's transfer requests.

    + *

    Specifies the IAM role that controls your users' access to your Amazon S3 + * bucket. The policies attached to this role will determine the level of access + * you want to provide your users when transferring files into and out of your + * Amazon S3 bucket or buckets. The IAM role should also contain a trust + * relationship that allows a file transfer protocol-enabled server to access your + * resources when servicing your users' transfer requests.

    */ inline DescribedUser& WithRole(const char* value) { SetRole(value); return *this;} /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline const Aws::Vector& GetSshPublicKeys() const{ return m_sshPublicKeys; } /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline bool SshPublicKeysHasBeenSet() const { return m_sshPublicKeysHasBeenSet; } /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline void SetSshPublicKeys(const Aws::Vector& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = value; } /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline void SetSshPublicKeys(Aws::Vector&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = std::move(value); } /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline DescribedUser& WithSshPublicKeys(const Aws::Vector& value) { SetSshPublicKeys(value); return *this;} /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline DescribedUser& WithSshPublicKeys(Aws::Vector&& value) { SetSshPublicKeys(std::move(value)); return *this;} /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline DescribedUser& AddSshPublicKeys(const SshPublicKey& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(value); return *this; } /** - *

    This property contains the public key portion of the Secure Shell (SSH) keys - * stored for the described user.

    + *

    Contains the public key portion of the Secure Shell (SSH) keys stored for the + * described user.

    */ inline DescribedUser& AddSshPublicKeys(SshPublicKey&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(std::move(value)); return *this; } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline const Aws::Vector& GetTags() const{ return m_tags; } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline DescribedUser& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline DescribedUser& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline DescribedUser& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** - *

    This property contains the key-value pairs for the user requested. Tag can be - * used to search for and group users for a variety of purposes.

    + *

    Contains the key-value pairs for the user requested. Tag can be used to + * search for and group users for a variety of purposes.

    */ inline DescribedUser& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline DescribedUser& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline DescribedUser& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    This property is the name of the user that was requested to be described. - * User names are used for authentication purposes. This is the string that will be - * used by your user when they log in to your SFTP server.

    + *

    The name of the user that was requested to be described. User names are used + * for authentication purposes. This is the string that will be used by your user + * when they log in to your file transfer protocol-enabled server.

    */ inline DescribedUser& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/EndpointDetails.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/EndpointDetails.h index 21ace02ca3f..2f339bc36e4 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/EndpointDetails.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/EndpointDetails.h @@ -36,10 +36,10 @@ namespace Model /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server and resources only within your VPC. To control incoming internet traffic, - * invoke the UpdateServer API and attach an Elastic IP to your - * server's endpoint.

    See Also:

    UpdateServer     API and attach + * an Elastic IP to your server's endpoint.

    See Also:

    AWS * API Reference

    */ @@ -54,128 +54,128 @@ namespace Model /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline const Aws::Vector& GetAddressAllocationIds() const{ return m_addressAllocationIds; } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline bool AddressAllocationIdsHasBeenSet() const { return m_addressAllocationIdsHasBeenSet; } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline void SetAddressAllocationIds(const Aws::Vector& value) { m_addressAllocationIdsHasBeenSet = true; m_addressAllocationIds = value; } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline void SetAddressAllocationIds(Aws::Vector&& value) { m_addressAllocationIdsHasBeenSet = true; m_addressAllocationIds = std::move(value); } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline EndpointDetails& WithAddressAllocationIds(const Aws::Vector& value) { SetAddressAllocationIds(value); return *this;} /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline EndpointDetails& WithAddressAllocationIds(Aws::Vector&& value) { SetAddressAllocationIds(std::move(value)); return *this;} /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline EndpointDetails& AddAddressAllocationIds(const Aws::String& value) { m_addressAllocationIdsHasBeenSet = true; m_addressAllocationIds.push_back(value); return *this; } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline EndpointDetails& AddAddressAllocationIds(Aws::String&& value) { m_addressAllocationIdsHasBeenSet = true; m_addressAllocationIds.push_back(std::move(value)); return *this; } /** *

    A list of address allocation IDs that are required to attach an Elastic IP - * address to your SFTP server's endpoint. This is only valid in the - * UpdateServer API.

    This property can only be use when - * EndpointType is set to VPC.

     + * address to your file transfer protocol-enabled server's endpoint. This is only + * valid in the UpdateServer API.

    This property can only + * be use when EndpointType is set to VPC.

     */ inline EndpointDetails& AddAddressAllocationIds(const char* value) { m_addressAllocationIdsHasBeenSet = true; m_addressAllocationIds.push_back(value); return *this; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline EndpointDetails& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline EndpointDetails& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline EndpointDetails& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline EndpointDetails& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } /** - *

    A list of subnet IDs that are required to host your SFTP server endpoint in - * your VPC.

    + *

    A list of subnet IDs that are required to host your file transfer + * protocol-enabled server endpoint in your VPC.

    */ inline EndpointDetails& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } @@ -222,50 +222,50 @@ namespace Model /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline const Aws::String& GetVpcId() const{ return m_vpcId; } /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline bool VpcIdHasBeenSet() const { return m_vpcIdHasBeenSet; } /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline void SetVpcId(const Aws::String& value) { m_vpcIdHasBeenSet = true; m_vpcId = value; } /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline void SetVpcId(Aws::String&& value) { m_vpcIdHasBeenSet = true; m_vpcId = std::move(value); } /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline void SetVpcId(const char* value) { m_vpcIdHasBeenSet = true; m_vpcId.assign(value); } /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline EndpointDetails& WithVpcId(const Aws::String& value) { SetVpcId(value); return *this;} /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline EndpointDetails& WithVpcId(Aws::String&& value) { SetVpcId(std::move(value)); return *this;} /** - *

    The VPC ID of the virtual private cloud in which the SFTP server's endpoint - * will be hosted.

    + *

    The VPC ID of the VPC in which a file transfer protocol-enabled server's + * endpoint will be hosted.

    */ inline EndpointDetails& WithVpcId(const char* value) { SetVpcId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/IdentityProviderDetails.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/IdentityProviderDetails.h index 932a97d3413..f2d41b5c8f5 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/IdentityProviderDetails.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/IdentityProviderDetails.h @@ -35,8 +35,8 @@ namespace Model /** *

    Returns information related to the type of user authentication that is in use - * for a server's users. A server can have only one method of - * authentication.

    See Also:

    See Also:

    AWS * API Reference

    */ @@ -50,99 +50,91 @@ namespace Model /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline const Aws::String& GetUrl() const{ return m_url; } /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline bool UrlHasBeenSet() const { return m_urlHasBeenSet; } /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline void SetUrl(const Aws::String& value) { m_urlHasBeenSet = true; m_url = value; } /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline void SetUrl(Aws::String&& value) { m_urlHasBeenSet = true; m_url = std::move(value); } /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline void SetUrl(const char* value) { m_urlHasBeenSet = true; m_url.assign(value); } /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline IdentityProviderDetails& WithUrl(const Aws::String& value) { SetUrl(value); return *this;} /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline IdentityProviderDetails& WithUrl(Aws::String&& value) { SetUrl(std::move(value)); return *this;} /** - *

    The Url parameter provides contains the location of the service - * endpoint used to authenticate users.

    + *

    Contains the location of the service endpoint used to authenticate users.

    */ inline IdentityProviderDetails& WithUrl(const char* value) { SetUrl(value); return *this;} /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline const Aws::String& GetInvocationRole() const{ return m_invocationRole; } /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline bool InvocationRoleHasBeenSet() const { return m_invocationRoleHasBeenSet; } /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline void SetInvocationRole(const Aws::String& value) { m_invocationRoleHasBeenSet = true; m_invocationRole = value; } /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline void SetInvocationRole(Aws::String&& value) { m_invocationRoleHasBeenSet = true; m_invocationRole = std::move(value); } /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline void SetInvocationRole(const char* value) { m_invocationRoleHasBeenSet = true; m_invocationRole.assign(value); } /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline IdentityProviderDetails& WithInvocationRole(const Aws::String& value) { SetInvocationRole(value); return *this;} /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline IdentityProviderDetails& WithInvocationRole(Aws::String&& value) { SetInvocationRole(std::move(value)); return *this;} /** - *

    The InvocationRole parameter provides the type of - * InvocationRole used to authenticate the user account.

    + *

    Provides the type of InvocationRole used to authenticate the + * user account.

    */ inline IdentityProviderDetails& WithInvocationRole(const char* value) { SetInvocationRole(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyRequest.h index 000a508c0b9..fe6a9c64189 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyRequest.h @@ -45,42 +45,50 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyRequest& WithServerId(const char* value) { SetServerId(value); return *this;} @@ -127,42 +135,50 @@ namespace Model /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline ImportSshPublicKeyRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline ImportSshPublicKeyRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    The name of the user account that is assigned to one or more servers.

    + *

    The name of the user account that is assigned to one or more file transfer + * protocol-enabled servers.

    */ inline ImportSshPublicKeyRequest& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyResult.h index 7110cdb32aa..61918874757 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ImportSshPublicKeyResult.h @@ -35,10 +35,10 @@ namespace Transfer namespace Model { /** - *

    This response identifies the user, the server they belong to, and the - * identifier of the SSH public key associated with that user. A user can have more - * than one key on each server that they are associated with.

    See - * Also:

    Identifies the user, the file transfer protocol-enabled server they belong + * to, and the identifier of the SSH public key associated with that user. A user + * can have more than one key on each server that they are associated + * with.

    See Also:

    AWS * API Reference

    */ @@ -51,80 +51,80 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server.

    */ inline ImportSshPublicKeyResult& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline const Aws::String& GetSshPublicKeyId() const{ return m_sshPublicKeyId; } /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline void SetSshPublicKeyId(const Aws::String& value) { m_sshPublicKeyId = value; } /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline void SetSshPublicKeyId(Aws::String&& value) { m_sshPublicKeyId = std::move(value); } /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline void SetSshPublicKeyId(const char* value) { m_sshPublicKeyId.assign(value); } /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline ImportSshPublicKeyResult& WithSshPublicKeyId(const Aws::String& value) { SetSshPublicKeyId(value); return *this;} /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline ImportSshPublicKeyResult& WithSshPublicKeyId(Aws::String&& value) { SetSshPublicKeyId(std::move(value)); return *this;} /** - *

    This identifier is the name given to a public key by the system that was - * imported.

    + *

    The name given to a public key by the system that was imported.

    */ inline ImportSshPublicKeyResult& WithSshPublicKeyId(const char* value) { SetSshPublicKeyId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersRequest.h index 335fb36ff1e..bac984126b1 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersRequest.h @@ -45,91 +45,91 @@ namespace Model /** - *

    Specifies the number of servers to return as a response to the - * ListServers query.

    + *

    Specifies the number of file transfer protocol-enabled servers to return as a + * response to the ListServers query.

    */ inline int GetMaxResults() const{ return m_maxResults; } /** - *

    Specifies the number of servers to return as a response to the - * ListServers query.

    + *

    Specifies the number of file transfer protocol-enabled servers to return as a + * response to the ListServers query.

    */ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** - *

    Specifies the number of servers to return as a response to the - * ListServers query.

    + *

    Specifies the number of file transfer protocol-enabled servers to return as a + * response to the ListServers query.

    */ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** - *

    Specifies the number of servers to return as a response to the - * ListServers query.

    + *

    Specifies the number of file transfer protocol-enabled servers to return as a + * response to the ListServers query.

    */ inline ListServersRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** - *

    When additional results are obtained from the ListServers + *

    When additional results are obtained from theListServers * command, a NextToken parameter is returned in the output. You can * then pass the NextToken parameter in a subsequent command to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersResult.h index e34609187c7..ef5b8fe0aeb 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListServersResult.h @@ -48,7 +48,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } @@ -56,7 +56,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(const Aws::String& value) { m_nextToken = value; } @@ -64,7 +64,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(Aws::String&& value) { m_nextToken = std::move(value); } @@ -72,7 +72,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline void SetNextToken(const char* value) { m_nextToken.assign(value); } @@ -80,7 +80,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersResult& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} @@ -88,7 +88,7 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersResult& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} @@ -96,43 +96,43 @@ namespace Model *

    When you can get additional results from the ListServers * operation, a NextToken parameter is returned in the output. In a * following command, you can pass in the NextToken parameter to - * continue listing additional servers.

    + * continue listing additional file transfer protocol-enabled servers.

    */ inline ListServersResult& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline const Aws::Vector& GetServers() const{ return m_servers; } /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline void SetServers(const Aws::Vector& value) { m_servers = value; } /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline void SetServers(Aws::Vector&& value) { m_servers = std::move(value); } /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline ListServersResult& WithServers(const Aws::Vector& value) { SetServers(value); return *this;} /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline ListServersResult& WithServers(Aws::Vector&& value) { SetServers(std::move(value)); return *this;} /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline ListServersResult& AddServers(const ListedServer& value) { m_servers.push_back(value); return *this; } /** - *

    An array of servers that were listed.

    + *

    An array of file transfer protocol-enabled servers that were listed.

    */ inline ListServersResult& AddServers(ListedServer&& value) { m_servers.push_back(std::move(value)); return *this; } diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListTagsForResourceResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListTagsForResourceResult.h index 824c569ce3d..0de1437550f 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListTagsForResourceResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListTagsForResourceResult.h @@ -45,37 +45,37 @@ namespace Model /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline void SetArn(const Aws::String& value) { m_arn = value; } /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline void SetArn(Aws::String&& value) { m_arn = std::move(value); } /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline void SetArn(const char* value) { m_arn.assign(value); } /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline ListTagsForResourceResult& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline ListTagsForResourceResult& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    This value is the ARN you specified to list the tags of.

    + *

    The ARN you specified to list the tags of.

    */ inline ListTagsForResourceResult& WithArn(const char* value) { SetArn(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersRequest.h index c02b4e6c962..91573c4f4a9 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersRequest.h @@ -135,50 +135,50 @@ namespace Model /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline ListUsersRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline ListUsersRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for a Secure File Transfer Protocol - * (SFTP) server that has users assigned to it.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that has users assigned to it.

    */ inline ListUsersRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersResult.h index 9052a47d88b..d41b54fc0f3 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListUsersResult.h @@ -102,44 +102,44 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline ListUsersResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline ListUsersResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that the users are - * assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the users are assigned to.

    */ inline ListUsersResult& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedServer.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedServer.h index 5eba289fc5d..ce7e19b89f0 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedServer.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedServer.h @@ -37,8 +37,8 @@ namespace Model { /** - *

    Returns properties of the server that was specified.

    See Also:

    - * Returns properties of a file transfer protocol-enabled server that was + * specified.

    See Also:

    AWS * API Reference

    */ @@ -52,240 +52,254 @@ namespace Model /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline ListedServer& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline ListedServer& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    The unique Amazon Resource Name (ARN) for the server to be listed.

    + *

    The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled + * server to be listed.

    */ inline ListedServer& WithArn(const char* value) { SetArn(value); return *this;} /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline const IdentityProviderType& GetIdentityProviderType() const{ return m_identityProviderType; } /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline bool IdentityProviderTypeHasBeenSet() const { return m_identityProviderTypeHasBeenSet; } /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline void SetIdentityProviderType(const IdentityProviderType& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = value; } /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline void SetIdentityProviderType(IdentityProviderType&& value) { m_identityProviderTypeHasBeenSet = true; m_identityProviderType = std::move(value); } /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline ListedServer& WithIdentityProviderType(const IdentityProviderType& value) { SetIdentityProviderType(value); return *this;} /** - *

    The authentication method used to validate a user for the server that was - * specified. This can include Secure Shell (SSH), user name and password - * combinations, or your own custom authentication method. Valid values include - * SERVICE_MANAGED or API_GATEWAY.

    + *

    The authentication method used to validate a user for a file transfer + * protocol-enabled server that was specified. This can include Secure Shell (SSH), + * user name and password combinations, or your own custom authentication method. + * Valid values include SERVICE_MANAGED or + * API_GATEWAY.

    */ inline ListedServer& WithIdentityProviderType(IdentityProviderType&& value) { SetIdentityProviderType(std::move(value)); return *this;} /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline const EndpointType& GetEndpointType() const{ return m_endpointType; } /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; } /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline void SetEndpointType(const EndpointType& value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; } /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline void SetEndpointType(EndpointType&& value) { m_endpointTypeHasBeenSet = true; m_endpointType = std::move(value); } /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline ListedServer& WithEndpointType(const EndpointType& value) { SetEndpointType(value); return *this;} /** - *

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP - * server is connected to a VPC endpoint, your server isn't accessible over the - * public internet.

    + *

    The type of VPC endpoint that your file transfer protocol-enabled server is + * connected to. If your server is connected to a VPC endpoint, your server isn't + * accessible over the public internet.

    */ inline ListedServer& WithEndpointType(EndpointType&& value) { SetEndpointType(std::move(value)); return *this;} /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline const Aws::String& GetLoggingRole() const{ return m_loggingRole; } /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; } /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline void SetLoggingRole(const Aws::String& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = value; } /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline void SetLoggingRole(Aws::String&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::move(value); } /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline void SetLoggingRole(const char* value) { m_loggingRoleHasBeenSet = true; m_loggingRole.assign(value); } /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline ListedServer& WithLoggingRole(const Aws::String& value) { SetLoggingRole(value); return *this;} /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline ListedServer& WithLoggingRole(Aws::String&& value) { SetLoggingRole(std::move(value)); return *this;} /** - *

    The AWS Identity and Access Management entity that allows the server to turn - * on Amazon CloudWatch logging.

    + *

    The AWS Identity and Access Management (IAM) entity that allows a file + * transfer protocol-enabled server to turn on Amazon CloudWatch logging.

    */ inline ListedServer& WithLoggingRole(const char* value) { SetLoggingRole(value); return *this;} /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline ListedServer& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline ListedServer& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    This value is the unique system assigned identifier for the SFTP servers that - * were listed.

    + *

    The unique system assigned identifier for a file transfer protocol-enabled + * servers that were listed.

    */ inline ListedServer& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -295,9 +309,9 @@ namespace Model inline const State& GetState() const{ return m_state; } /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -307,9 +321,9 @@ namespace Model inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -319,9 +333,9 @@ namespace Model inline void SetState(const State& value) { m_stateHasBeenSet = true; m_state = value; } /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -331,9 +345,9 @@ namespace Model inline void SetState(State&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -343,9 +357,9 @@ namespace Model inline ListedServer& WithState(const State& value) { SetState(value); return *this;} /** - *

    This property describes the condition of the SFTP server for the server that - * was described. A value of ONLINE> indicates that the server can - * accept jobs and transfer files. A State value of + *

    Describes the condition of a file transfer protocol-enabled server for the + * server that was described. A value of ONLINE indicates that the + * server can accept jobs and transfer files. A State value of * OFFLINE means that the server cannot perform file transfer * operations.

    The states of STARTING and STOPPING * indicate that the server is in an intermediate state, either not fully able to @@ -356,26 +370,30 @@ namespace Model /** - *

    This property is a numeric value that indicates the number of users that are - * assigned to the SFTP server you specified with the ServerId.

    + *

    A numeric value that indicates the number of users that are assigned to a + * file transfer protocol-enabled server you specified with the + * ServerId.

    */ inline int GetUserCount() const{ return m_userCount; } /** - *

    This property is a numeric value that indicates the number of users that are - * assigned to the SFTP server you specified with the ServerId.

    + *

    A numeric value that indicates the number of users that are assigned to a + * file transfer protocol-enabled server you specified with the + * ServerId.

    */ inline bool UserCountHasBeenSet() const { return m_userCountHasBeenSet; } /** - *

    This property is a numeric value that indicates the number of users that are - * assigned to the SFTP server you specified with the ServerId.

    + *

    A numeric value that indicates the number of users that are assigned to a + * file transfer protocol-enabled server you specified with the + * ServerId.

    */ inline void SetUserCount(int value) { m_userCountHasBeenSet = true; m_userCount = value; } /** - *

    This property is a numeric value that indicates the number of users that are - * assigned to the SFTP server you specified with the ServerId.

    + *

    A numeric value that indicates the number of users that are assigned to a + * file transfer protocol-enabled server you specified with the + * ServerId.

    */ inline ListedServer& WithUserCount(int value) { SetUserCount(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedUser.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedUser.h index 01009348a58..dedec631483 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedUser.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/ListedUser.h @@ -50,99 +50,99 @@ namespace Model /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline ListedUser& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline ListedUser& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    This property is the unique Amazon Resource Name (ARN) for the user that you - * want to learn about.

    + *

    The unique Amazon Resource Name (ARN) for the user that you want to learn + * about.

    */ inline ListedUser& WithArn(const char* value) { SetArn(value); return *this;} /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline ListedUser& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline ListedUser& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** - *

    This value specifies the location that files are written to or read from an - * Amazon S3 bucket for the user you specify by their ARN.

    + *

    Specifies the location that files are written to or read from an Amazon S3 + * bucket for the user you specify by their ARN.

    */ inline ListedUser& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} @@ -150,150 +150,154 @@ namespace Model /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline ListedUser& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** *

    The type of landing directory (folder) you mapped for your users' home * directory. If you set it to PATH, the user will see the absolute - * Amazon S3 bucket paths as is in their SFTP clients. If you set it - * LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * Amazon S3 bucket paths as is in their file transfer protocol clients. If you set + * it LOGICAL, you will need to provide mappings in the + * HomeDirectoryMappings for how you want to make Amazon S3 paths + * visible to your users.

    */ inline ListedUser& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline const Aws::String& GetRole() const{ return m_role; } /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline ListedUser& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline ListedUser& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** *

    The role in use by this user. A role is an AWS Identity and Access - * Management (IAM) entity that, in this case, allows the SFTP server to act on a - * user's behalf. It allows the server to inherit the trust relationship that - * enables that user to perform file operations to their Amazon S3 bucket.

    + * Management (IAM) entity that, in this case, allows a file transfer + * protocol-enabled server to act on a user's behalf. It allows the server to + * inherit the trust relationship that enables that user to perform file operations + * to their Amazon S3 bucket.

    */ inline ListedUser& WithRole(const char* value) { SetRole(value); return *this;} /** - *

    This value is the number of SSH public keys stored for the user you - * specified.

    + *

    The number of SSH public keys stored for the user you specified.

    */ inline int GetSshPublicKeyCount() const{ return m_sshPublicKeyCount; } /** - *

    This value is the number of SSH public keys stored for the user you - * specified.

    + *

    The number of SSH public keys stored for the user you specified.

    */ inline bool SshPublicKeyCountHasBeenSet() const { return m_sshPublicKeyCountHasBeenSet; } /** - *

    This value is the number of SSH public keys stored for the user you - * specified.

    + *

    The number of SSH public keys stored for the user you specified.

    */ inline void SetSshPublicKeyCount(int value) { m_sshPublicKeyCountHasBeenSet = true; m_sshPublicKeyCount = value; } /** - *

    This value is the number of SSH public keys stored for the user you - * specified.

    + *

    The number of SSH public keys stored for the user you specified.

    */ inline ListedUser& WithSshPublicKeyCount(int value) { SetSshPublicKeyCount(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Protocol.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Protocol.h new file mode 100644 index 00000000000..49ae8d34c06 --- /dev/null +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Protocol.h @@ -0,0 +1,42 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include + +namespace Aws +{ +namespace Transfer +{ +namespace Model +{ + enum class Protocol + { + NOT_SET, + SFTP, + FTP, + FTPS + }; + +namespace ProtocolMapper +{ +AWS_TRANSFER_API Protocol GetProtocolForName(const Aws::String& name); + +AWS_TRANSFER_API Aws::String GetNameForProtocol(Protocol value); +} // namespace ProtocolMapper +} // namespace Model +} // namespace Transfer +} // namespace Aws diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/SshPublicKey.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/SshPublicKey.h index 643ffa44887..77fb2a46a3d 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/SshPublicKey.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/SshPublicKey.h @@ -36,11 +36,11 @@ namespace Model /** *

    Provides information about the public Secure Shell (SSH) key that is - * associated with a user account for a specific server (as identified by - * ServerId). The information returned includes the date the key was - * imported, the public key contents, and the public key ID. A user can store more - * than one SSH public key associated with their user name on a specific SFTP - * server.

    See Also:

    ServerId    ). The information returned + * includes the date the key was imported, the public key contents, and the public + * key ID. A user can store more than one SSH public key associated with their user + * name on a specific server.

    See Also:

    AWS * API Reference

    */ diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StartServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StartServerRequest.h index 43f5e624d95..bb1701ce6eb 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StartServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StartServerRequest.h @@ -45,42 +45,50 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline StartServerRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline StartServerRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that you start.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you start.

    */ inline StartServerRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StopServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StopServerRequest.h index b660353c346..dca0091a2ab 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StopServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/StopServerRequest.h @@ -45,42 +45,50 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline StopServerRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline StopServerRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that you stopped.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that you stopped.

    */ inline StopServerRequest& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Tag.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Tag.h index 362dfd3dcc0..d51045b3f9e 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Tag.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/Tag.h @@ -94,50 +94,42 @@ namespace Model /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline const Aws::String& GetValue() const{ return m_value; } /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline bool ValueHasBeenSet() const { return m_valueHasBeenSet; } /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline void SetValue(const Aws::String& value) { m_valueHasBeenSet = true; m_value = value; } /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline void SetValue(Aws::String&& value) { m_valueHasBeenSet = true; m_value = std::move(value); } /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline void SetValue(const char* value) { m_valueHasBeenSet = true; m_value.assign(value); } /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline Tag& WithValue(const Aws::String& value) { SetValue(value); return *this;} /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline Tag& WithValue(Aws::String&& value) { SetValue(std::move(value)); return *this;} /** - *

    This property contains one or more values that you assigned to the key name - * you create.

    + *

    Contains one or more values that you assigned to the key name you create.

    */ inline Tag& WithValue(const char* value) { SetValue(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderRequest.h index afddd8f728f..d189aeed60d 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderRequest.h @@ -17,6 +17,7 @@ #include #include #include +#include #include namespace Aws @@ -45,91 +46,99 @@ namespace Model /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline TestIdentityProviderRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline TestIdentityProviderRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned identifier for a specific server. That server's user - * authentication method is tested with a user name and password.

    + *

    A system-assigned identifier for a specific file transfer protocol-enabled + * server. That server's user authentication method is tested with a user name and + * password.

    */ inline TestIdentityProviderRequest& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline TestIdentityProviderRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline TestIdentityProviderRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    This request parameter is the name of the user account to be tested.

    + *

    The name of the user account to be tested.

    */ inline TestIdentityProviderRequest& WithUserName(const char* value) { SetUserName(value); return *this;} @@ -174,6 +183,55 @@ namespace Model */ inline TestIdentityProviderRequest& WithUserPassword(const char* value) { SetUserPassword(value); return *this;} + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline const Protocol& GetServerProtocol() const{ return m_serverProtocol; } + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline bool ServerProtocolHasBeenSet() const { return m_serverProtocolHasBeenSet; } + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline void SetServerProtocol(const Protocol& value) { m_serverProtocolHasBeenSet = true; m_serverProtocol = value; } + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline void SetServerProtocol(Protocol&& value) { m_serverProtocolHasBeenSet = true; m_serverProtocol = std::move(value); } + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline TestIdentityProviderRequest& WithServerProtocol(const Protocol& value) { SetServerProtocol(value); return *this;} + + /** + *

    The type of file transfer protocol to be tested.

    The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP)

    • File Transfer Protocol Secure (FTPS)

    • + *

      File Transfer Protocol (FTP)

    + */ + inline TestIdentityProviderRequest& WithServerProtocol(Protocol&& value) { SetServerProtocol(std::move(value)); return *this;} + private: Aws::String m_serverId; @@ -184,6 +242,9 @@ namespace Model Aws::String m_userPassword; bool m_userPasswordHasBeenSet; + + Protocol m_serverProtocol; + bool m_serverProtocolHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderResult.h index 7c6b87a93f0..2e832e41ed1 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/TestIdentityProviderResult.h @@ -95,37 +95,37 @@ namespace Model /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline const Aws::String& GetMessage() const{ return m_message; } /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline void SetMessage(const Aws::String& value) { m_message = value; } /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline void SetMessage(Aws::String&& value) { m_message = std::move(value); } /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline void SetMessage(const char* value) { m_message.assign(value); } /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline TestIdentityProviderResult& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline TestIdentityProviderResult& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** - *

    A message that indicates whether the test was successful or not.

    + *

    A message that indicates whether the test was successful or not.

    */ inline TestIdentityProviderResult& WithMessage(const char* value) { SetMessage(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UntagResourceRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UntagResourceRequest.h index fadab8ded50..59828693d0c 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UntagResourceRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UntagResourceRequest.h @@ -46,58 +46,58 @@ namespace Model /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline const Aws::String& GetArn() const{ return m_arn; } /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline UntagResourceRequest& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline UntagResourceRequest& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** - *

    This is the value of the resource that will have the tag removed. An Amazon - * Resource Name (ARN) is an identifier for a specific AWS resource, such as a - * server, user, or role.

    + *

    The value of the resource that will have the tag removed. An Amazon Resource + * Name (ARN) is an identifier for a specific AWS resource, such as a server, user, + * or role.

    */ inline UntagResourceRequest& WithArn(const char* value) { SetArn(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerRequest.h index ed1c9d758d8..7ecf0205063 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerRequest.h @@ -16,10 +16,12 @@ #pragma once #include #include +#include #include #include -#include #include +#include +#include #include namespace Aws @@ -47,106 +49,163 @@ namespace Model Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline const Aws::String& GetCertificate() const{ return m_certificate; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline bool CertificateHasBeenSet() const { return m_certificateHasBeenSet; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const Aws::String& value) { m_certificateHasBeenSet = true; m_certificate = value; } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(Aws::String&& value) { m_certificateHasBeenSet = true; m_certificate = std::move(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline void SetCertificate(const char* value) { m_certificateHasBeenSet = true; m_certificate.assign(value); } + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline UpdateServerRequest& WithCertificate(const Aws::String& value) { SetCertificate(value); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline UpdateServerRequest& WithCertificate(Aws::String&& value) { SetCertificate(std::move(value)); return *this;} + + /** + *

    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) + * certificate. Required when Protocols is set to + * FTPS.

    + */ + inline UpdateServerRequest& WithCertificate(const char* value) { SetCertificate(value); return *this;} + + /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline const EndpointDetails& GetEndpointDetails() const{ return m_endpointDetails; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline bool EndpointDetailsHasBeenSet() const { return m_endpointDetailsHasBeenSet; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline void SetEndpointDetails(const EndpointDetails& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = value; } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline void SetEndpointDetails(EndpointDetails&& value) { m_endpointDetailsHasBeenSet = true; m_endpointDetails = std::move(value); } /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline UpdateServerRequest& WithEndpointDetails(const EndpointDetails& value) { SetEndpointDetails(value); return *this;} /** *

    The virtual private cloud (VPC) endpoint settings that are configured for - * your SFTP server. With a VPC endpoint, you can restrict access to your SFTP - * server to resources only within your VPC. To control incoming internet traffic, - * you will need to associate one or more Elastic IP addresses with your server's - * endpoint.

    + * your file transfer protocol-enabled server. With a VPC endpoint, you can + * restrict access to your server to resources only within your VPC. To control + * incoming internet traffic, you will need to associate one or more Elastic IP + * addresses with your server's endpoint.

    */ inline UpdateServerRequest& WithEndpointDetails(EndpointDetails&& value) { SetEndpointDetails(std::move(value)); return *this;} /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline const EndpointType& GetEndpointType() const{ return m_endpointType; } /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline bool EndpointTypeHasBeenSet() const { return m_endpointTypeHasBeenSet; } /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline void SetEndpointType(const EndpointType& value) { m_endpointTypeHasBeenSet = true; m_endpointType = value; } /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline void SetEndpointType(EndpointType&& value) { m_endpointTypeHasBeenSet = true; m_endpointType = std::move(value); } /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline UpdateServerRequest& WithEndpointType(const EndpointType& value) { SetEndpointType(value); return *this;} /** - *

    The type of endpoint that you want your SFTP server to connect to. You can - * choose to connect to the public internet or a virtual private cloud (VPC) - * endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public - * internet.

    + *

    The type of endpoint that you want your file transfer protocol-enabled server + * to connect to. You can choose to connect to the public internet or a VPC + * endpoint. With a VPC endpoint, your server isn't accessible over the public + * internet.

    */ inline UpdateServerRequest& WithEndpointType(EndpointType&& value) { SetEndpointType(std::move(value)); return *this;} @@ -154,236 +213,320 @@ namespace Model /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline const Aws::String& GetHostKey() const{ return m_hostKey; } /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline bool HostKeyHasBeenSet() const { return m_hostKeyHasBeenSet; } /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(const Aws::String& value) { m_hostKeyHasBeenSet = true; m_hostKey = value; } /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(Aws::String&& value) { m_hostKeyHasBeenSet = true; m_hostKey = std::move(value); } /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline void SetHostKey(const char* value) { m_hostKeyHasBeenSet = true; m_hostKey.assign(value); } /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline UpdateServerRequest& WithHostKey(const Aws::String& value) { SetHostKey(value); return *this;} /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline UpdateServerRequest& WithHostKey(Aws::String&& value) { SetHostKey(std::move(value)); return *this;} /** *

    The RSA private key as generated by ssh-keygen -N "" -f * my-new-server-key.

    If you aren't planning to migrate - * existing users from an existing SFTP server to a new AWS SFTP server, don't - * update the host key. Accidentally changing a server's host key can be - * disruptive.

    For more information, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" - * in the AWS SFTP User Guide.

    + * existing users from an existing file transfer protocol-enabled server to a new + * server, don't update the host key. Accidentally changing a server's host key can + * be disruptive.

    For more information, see Changing + * the Host Key for Your AWS Transfer Family Server in the AWS Transfer + * Family User Guide.

    */ inline UpdateServerRequest& WithHostKey(const char* value) { SetHostKey(value); return *this;} /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline const IdentityProviderDetails& GetIdentityProviderDetails() const{ return m_identityProviderDetails; } /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline bool IdentityProviderDetailsHasBeenSet() const { return m_identityProviderDetailsHasBeenSet; } /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline void SetIdentityProviderDetails(const IdentityProviderDetails& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = value; } /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline void SetIdentityProviderDetails(IdentityProviderDetails&& value) { m_identityProviderDetailsHasBeenSet = true; m_identityProviderDetails = std::move(value); } /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline UpdateServerRequest& WithIdentityProviderDetails(const IdentityProviderDetails& value) { SetIdentityProviderDetails(value); return *this;} /** - *

    This response parameter is an array containing all of the information - * required to call a customer's authentication API method.

    + *

    An array containing all of the information required to call a customer's + * authentication API method.

    */ inline UpdateServerRequest& WithIdentityProviderDetails(IdentityProviderDetails&& value) { SetIdentityProviderDetails(std::move(value)); return *this;} /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline const Aws::String& GetLoggingRole() const{ return m_loggingRole; } /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline bool LoggingRoleHasBeenSet() const { return m_loggingRoleHasBeenSet; } /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline void SetLoggingRole(const Aws::String& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = value; } /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline void SetLoggingRole(Aws::String&& value) { m_loggingRoleHasBeenSet = true; m_loggingRole = std::move(value); } /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline void SetLoggingRole(const char* value) { m_loggingRoleHasBeenSet = true; m_loggingRole.assign(value); } /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline UpdateServerRequest& WithLoggingRole(const Aws::String& value) { SetLoggingRole(value); return *this;} /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline UpdateServerRequest& WithLoggingRole(Aws::String&& value) { SetLoggingRole(std::move(value)); return *this;} /** - *

    A value that changes the AWS Identity and Access Management (IAM) role that - * allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or - * off.

    + *

    Changes the AWS Identity and Access Management (IAM) role that allows Amazon + * S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    */ inline UpdateServerRequest& WithLoggingRole(const char* value) { SetLoggingRole(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline const Aws::Vector& GetProtocols() const{ return m_protocols; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline bool ProtocolsHasBeenSet() const { return m_protocolsHasBeenSet; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(const Aws::Vector& value) { m_protocolsHasBeenSet = true; m_protocols = value; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline void SetProtocols(Aws::Vector&& value) { m_protocolsHasBeenSet = true; m_protocols = std::move(value); } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline UpdateServerRequest& WithProtocols(const Aws::Vector& value) { SetProtocols(value); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline UpdateServerRequest& WithProtocols(Aws::Vector&& value) { SetProtocols(std::move(value)); return *this;} + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline UpdateServerRequest& AddProtocols(const Protocol& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(value); return *this; } + + /** + *

    Specifies the file transfer protocol or protocols over which your file + * transfer protocol client can connect to your server's endpoint. The available + * protocols are:

    • Secure Shell (SSH) File Transfer Protocol + * (SFTP): File transfer over SSH

    • File Transfer Protocol Secure + * (FTPS): File transfer with TLS encryption

    • File Transfer + * Protocol (FTP): Unencrypted file transfer

    + */ + inline UpdateServerRequest& AddProtocols(Protocol&& value) { m_protocolsHasBeenSet = true; m_protocols.push_back(std::move(value)); return *this; } + + + /** + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateServerRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateServerRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateServerRequest& WithServerId(const char* value) { SetServerId(value); return *this;} private: + Aws::String m_certificate; + bool m_certificateHasBeenSet; + EndpointDetails m_endpointDetails; bool m_endpointDetailsHasBeenSet; @@ -399,6 +542,9 @@ namespace Model Aws::String m_loggingRole; bool m_loggingRoleHasBeenSet; + Aws::Vector m_protocols; + bool m_protocolsHasBeenSet; + Aws::String m_serverId; bool m_serverIdHasBeenSet; }; diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerResult.h index 25d6fb1ef6d..bd113241293 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateServerResult.h @@ -43,44 +43,44 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline UpdateServerResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline UpdateServerResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server that the user account - * is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server that the user account is assigned to.

    */ inline UpdateServerResult& WithServerId(const char* value) { SetServerId(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserRequest.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserRequest.h index 0febf11933a..3f0ce90b062 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserRequest.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserRequest.h @@ -48,304 +48,320 @@ namespace Model /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline UpdateUserRequest& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline UpdateUserRequest& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** - *

    A parameter that specifies the landing directory (folder) for a user when - * they log in to the server using their client.

    An example is - * <your-Amazon-S3-bucket-name>/home/username.

    + *

    Specifies the landing directory (folder) for a user when they log in to the + * file transfer protocol-enabled server using their file transfer protocol + * client.

    An example is + * your-Amazon-S3-bucket-name>/home/username.

    */ inline UpdateUserRequest& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline UpdateUserRequest& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** *

    The type of landing directory (folder) you want your users' home directory to - * be when they log into the SFTP serve. If you set it to PATH, the - * user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. - * If you set it LOGICAL, you will need to provide mappings in the - * HomeDirectoryMappings for how you want to make S3 paths visible to - * your user.

    + * be when they log into the file transfer protocol-enabled server. If you set it + * to PATH, the user will see the absolute Amazon S3 bucket paths as + * is in their file transfer protocol clients. If you set it LOGICAL, + * you will need to provide mappings in the HomeDirectoryMappings for + * how you want to make Amazon S3 paths visible to your users.

    */ inline UpdateUserRequest& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline const Aws::Vector& GetHomeDirectoryMappings() const{ return m_homeDirectoryMappings; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline bool HomeDirectoryMappingsHasBeenSet() const { return m_homeDirectoryMappingsHasBeenSet; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline void SetHomeDirectoryMappings(const Aws::Vector& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = value; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline void SetHomeDirectoryMappings(Aws::Vector&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = std::move(value); } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline UpdateUserRequest& WithHomeDirectoryMappings(const Aws::Vector& value) { SetHomeDirectoryMappings(value); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline UpdateUserRequest& WithHomeDirectoryMappings(Aws::Vector&& value) { SetHomeDirectoryMappings(std::move(value)); return *this;} /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline UpdateUserRequest& AddHomeDirectoryMappings(const HomeDirectoryMapEntry& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(value); return *this; } /** - *

    Logical directory mappings that specify what S3 paths and keys should be - * visible to your user and how you want to make them visible. You will need to + *

    Logical directory mappings that specify what Amazon S3 paths and keys should + * be visible to your user and how you want to make them visible. You will need to * specify the "Entry" and "Target" pair, where * Entry shows how the path is made visible and Target is - * the actual S3 path. If you only specify a target, it will be displayed as is. - * You will need to also make sure that your AWS IAM Role provides access to paths - * in Target. The following is an example.

    '[ + * the actual Amazon S3 path. If you only specify a target, it will be displayed as + * is. You will need to also make sure that your AWS IAM Role provides access to + * paths in Target. The following is an example.

    '[ * "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": * "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

    In - * most cases, you can use this value instead of the scope down policy to lock your + * most cases, you can use this value instead of the scope-down policy to lock your * user down to the designated home directory ("chroot"). To do this, you can set * Entry to '/' and set Target to the HomeDirectory - * parameter value.

    If the target of a logical directory entry does - * not exist in S3, the entry will be ignored. As a workaround, you can use the S3 - * api to create 0 byte objects as place holders for your directory. If using the - * CLI, use the s3api call instead of s3 so you can use the put-object operation. - * For example, you use the following: aws s3api put-object --bucket - * bucketname --key path/to/folder/. Make sure that the end of the key name - * ends in a / for it to be considered a folder.

    + * parameter value.

    If the target of a logical directory entry does + * not exist in Amazon S3, the entry will be ignored. As a workaround, you can use + * the Amazon S3 api to create 0 byte objects as place holders for your directory. + * If using the CLI, use the s3api call instead of s3 so + * you can use the put-object operation. For example, you use the following: + * aws s3api put-object --bucket bucketname --key path/to/folder/. + * Make sure that the end of the key name ends in a / for it to be considered a + * folder.

     */ inline UpdateUserRequest& AddHomeDirectoryMappings(HomeDirectoryMapEntry&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(std::move(value)); return *this; } @@ -357,14 +373,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline const Aws::String& GetPolicy() const{ return m_policy; } @@ -375,14 +391,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } @@ -393,14 +409,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } @@ -411,14 +427,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } @@ -429,14 +445,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } @@ -447,14 +463,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline UpdateUserRequest& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;} @@ -465,14 +481,14 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline UpdateUserRequest& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;} @@ -483,217 +499,225 @@ namespace Model * you can use inside this policy include ${Transfer:UserName}, * ${Transfer:HomeDirectory}, and * ${Transfer:HomeBucket}.

    For scope-down policies, AWS - * Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon - * Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass - * it in the Policy argument.

    For an example of a scope-down - * policy, see - * "https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating - * a Scope-Down Policy.

    For more information, see - * "https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html" in the - * AWS Security Token Service API Reference.

     + * Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource + * Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the + * Policy argument.

    For an example of a scope-down policy, see + * Creating + * a Scope-Down Policy.

    For more information, see AssumeRole + * in the AWS Security Token Service API Reference.

    */ inline UpdateUserRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline const Aws::String& GetRole() const{ return m_role; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline UpdateUserRequest& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline UpdateUserRequest& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** - *

    The IAM role that controls your user's access to your Amazon S3 bucket. The + *

    The IAM role that controls your users' access to your Amazon S3 bucket. The * policies attached to this role will determine the level of access you want to * provide your users when transferring files into and out of your Amazon S3 bucket * or buckets. The IAM role should also contain a trust relationship that allows - * the Secure File Transfer Protocol (SFTP) server to access your resources when - * servicing your SFTP user's transfer requests.

    + * the file transfer protocol-enabled server to access your resources when + * servicing your users' transfer requests.

    */ inline UpdateUserRequest& WithRole(const char* value) { SetRole(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const Aws::String& value) { m_serverIdHasBeenSet = true; m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(Aws::String&& value) { m_serverIdHasBeenSet = true; m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const char* value) { m_serverIdHasBeenSet = true; m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserRequest& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserRequest& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserRequest& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline UpdateUserRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline UpdateUserRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    A unique string that identifies a user and is associated with a server as - * specified by the ServerId. This is the string that will be used by - * your user when they log in to your SFTP server. This user name is a minimum of 3 - * and a maximum of 32 characters long. The following are valid characters: a-z, - * A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    + *

    A unique string that identifies a user and is associated with a file transfer + * protocol-enabled server as specified by the ServerId. This is the + * string that will be used by your user when they log in to your server. This user + * name is a minimum of 3 and a maximum of 32 characters long. The following are + * valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't + * start with a hyphen.

    */ inline UpdateUserRequest& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserResult.h b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserResult.h index e4f9f3f1261..ce01d59a3d4 100644 --- a/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserResult.h +++ b/aws-cpp-sdk-awstransfer/include/aws/awstransfer/model/UpdateUserResult.h @@ -35,8 +35,9 @@ namespace Transfer namespace Model { /** - *

    UpdateUserResponse returns the user name and server identifier - * for the request to update a user's properties.

    See Also:

    UpdateUserResponse returns the user name and file transfer + * protocol-enabled server identifier for the request to update a user's + * properties.

    See Also:

    AWS * API Reference

    */ @@ -49,87 +50,87 @@ namespace Model /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline const Aws::String& GetServerId() const{ return m_serverId; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const Aws::String& value) { m_serverId = value; } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(Aws::String&& value) { m_serverId = std::move(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline void SetServerId(const char* value) { m_serverId.assign(value); } /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserResult& WithServerId(const Aws::String& value) { SetServerId(value); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserResult& WithServerId(Aws::String&& value) { SetServerId(std::move(value)); return *this;} /** - *

    A system-assigned unique identifier for an SFTP server instance that the user - * account is assigned to.

    + *

    A system-assigned unique identifier for a file transfer protocol-enabled + * server instance that the user account is assigned to.

    */ inline UpdateUserResult& WithServerId(const char* value) { SetServerId(value); return *this;} /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline const Aws::String& GetUserName() const{ return m_userName; } /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline void SetUserName(const Aws::String& value) { m_userName = value; } /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline void SetUserName(Aws::String&& value) { m_userName = std::move(value); } /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline void SetUserName(const char* value) { m_userName.assign(value); } /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline UpdateUserResult& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline UpdateUserResult& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** - *

    The unique identifier for a user that is assigned to the SFTP server instance - * that was specified in the request.

    + *

    The unique identifier for a user that is assigned to a file transfer + * protocol-enabled server instance that was specified in the request.

    */ inline UpdateUserResult& WithUserName(const char* value) { SetUserName(value); return *this;} diff --git a/aws-cpp-sdk-awstransfer/source/model/CreateServerRequest.cpp b/aws-cpp-sdk-awstransfer/source/model/CreateServerRequest.cpp index eab2f3b7fed..73b9cbf8d29 100644 --- a/aws-cpp-sdk-awstransfer/source/model/CreateServerRequest.cpp +++ b/aws-cpp-sdk-awstransfer/source/model/CreateServerRequest.cpp @@ -23,6 +23,7 @@ using namespace Aws::Utils::Json; using namespace Aws::Utils; CreateServerRequest::CreateServerRequest() : + m_certificateHasBeenSet(false), m_endpointDetailsHasBeenSet(false), m_endpointType(EndpointType::NOT_SET), m_endpointTypeHasBeenSet(false), @@ -31,6 +32,7 @@ CreateServerRequest::CreateServerRequest() : m_identityProviderType(IdentityProviderType::NOT_SET), m_identityProviderTypeHasBeenSet(false), m_loggingRoleHasBeenSet(false), + m_protocolsHasBeenSet(false), m_tagsHasBeenSet(false) { } @@ -39,6 +41,12 @@ Aws::String CreateServerRequest::SerializePayload() const { JsonValue payload; + if(m_certificateHasBeenSet) + { + payload.WithString("Certificate", m_certificate); + + } + if(m_endpointDetailsHasBeenSet) { payload.WithObject("EndpointDetails", m_endpointDetails.Jsonize()); @@ -73,6 +81,17 @@ Aws::String CreateServerRequest::SerializePayload() const } + if(m_protocolsHasBeenSet) + { + Array protocolsJsonList(m_protocols.size()); + for(unsigned protocolsIndex = 0; protocolsIndex < protocolsJsonList.GetLength(); ++protocolsIndex) + { + protocolsJsonList[protocolsIndex].AsString(ProtocolMapper::GetNameForProtocol(m_protocols[protocolsIndex])); + } + payload.WithArray("Protocols", std::move(protocolsJsonList)); + + } + if(m_tagsHasBeenSet) { Array tagsJsonList(m_tags.size()); diff --git a/aws-cpp-sdk-awstransfer/source/model/DescribedServer.cpp b/aws-cpp-sdk-awstransfer/source/model/DescribedServer.cpp index 7d606c996d6..3bfcb67286e 100644 --- a/aws-cpp-sdk-awstransfer/source/model/DescribedServer.cpp +++ b/aws-cpp-sdk-awstransfer/source/model/DescribedServer.cpp @@ -30,6 +30,7 @@ namespace Model DescribedServer::DescribedServer() : m_arnHasBeenSet(false), + m_certificateHasBeenSet(false), m_endpointDetailsHasBeenSet(false), m_endpointType(EndpointType::NOT_SET), m_endpointTypeHasBeenSet(false), @@ -38,6 +39,7 @@ DescribedServer::DescribedServer() : m_identityProviderType(IdentityProviderType::NOT_SET), m_identityProviderTypeHasBeenSet(false), m_loggingRoleHasBeenSet(false), + m_protocolsHasBeenSet(false), m_serverIdHasBeenSet(false), m_state(State::NOT_SET), m_stateHasBeenSet(false), @@ -49,6 +51,7 @@ DescribedServer::DescribedServer() : DescribedServer::DescribedServer(JsonView jsonValue) : m_arnHasBeenSet(false), + m_certificateHasBeenSet(false), m_endpointDetailsHasBeenSet(false), m_endpointType(EndpointType::NOT_SET), m_endpointTypeHasBeenSet(false), @@ -57,6 +60,7 @@ DescribedServer::DescribedServer(JsonView jsonValue) : m_identityProviderType(IdentityProviderType::NOT_SET), m_identityProviderTypeHasBeenSet(false), m_loggingRoleHasBeenSet(false), + m_protocolsHasBeenSet(false), m_serverIdHasBeenSet(false), m_state(State::NOT_SET), m_stateHasBeenSet(false), @@ -76,6 +80,13 @@ DescribedServer& DescribedServer::operator =(JsonView jsonValue) m_arnHasBeenSet = true; } + if(jsonValue.ValueExists("Certificate")) + { + m_certificate = jsonValue.GetString("Certificate"); + + m_certificateHasBeenSet = true; + } + if(jsonValue.ValueExists("EndpointDetails")) { m_endpointDetails = jsonValue.GetObject("EndpointDetails"); @@ -118,6 +129,16 @@ DescribedServer& DescribedServer::operator =(JsonView jsonValue) m_loggingRoleHasBeenSet = true; } + if(jsonValue.ValueExists("Protocols")) + { + Array protocolsJsonList = jsonValue.GetArray("Protocols"); + for(unsigned protocolsIndex = 0; protocolsIndex < protocolsJsonList.GetLength(); ++protocolsIndex) + { + m_protocols.push_back(ProtocolMapper::GetProtocolForName(protocolsJsonList[protocolsIndex].AsString())); + } + m_protocolsHasBeenSet = true; + } + if(jsonValue.ValueExists("ServerId")) { m_serverId = jsonValue.GetString("ServerId"); @@ -162,6 +183,12 @@ JsonValue DescribedServer::Jsonize() const } + if(m_certificateHasBeenSet) + { + payload.WithString("Certificate", m_certificate); + + } + if(m_endpointDetailsHasBeenSet) { payload.WithObject("EndpointDetails", m_endpointDetails.Jsonize()); @@ -196,6 +223,17 @@ JsonValue DescribedServer::Jsonize() const } + if(m_protocolsHasBeenSet) + { + Array protocolsJsonList(m_protocols.size()); + for(unsigned protocolsIndex = 0; protocolsIndex < protocolsJsonList.GetLength(); ++protocolsIndex) + { + protocolsJsonList[protocolsIndex].AsString(ProtocolMapper::GetNameForProtocol(m_protocols[protocolsIndex])); + } + payload.WithArray("Protocols", std::move(protocolsJsonList)); + + } + if(m_serverIdHasBeenSet) { payload.WithString("ServerId", m_serverId); diff --git a/aws-cpp-sdk-awstransfer/source/model/Protocol.cpp b/aws-cpp-sdk-awstransfer/source/model/Protocol.cpp new file mode 100644 index 00000000000..96859196020 --- /dev/null +++ b/aws-cpp-sdk-awstransfer/source/model/Protocol.cpp @@ -0,0 +1,87 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include + +using namespace Aws::Utils; + + +namespace Aws +{ + namespace Transfer + { + namespace Model + { + namespace ProtocolMapper + { + + static const int SFTP_HASH = HashingUtils::HashString("SFTP"); + static const int FTP_HASH = HashingUtils::HashString("FTP"); + static const int FTPS_HASH = HashingUtils::HashString("FTPS"); + + + Protocol GetProtocolForName(const Aws::String& name) + { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == SFTP_HASH) + { + return Protocol::SFTP; + } + else if (hashCode == FTP_HASH) + { + return Protocol::FTP; + } + else if (hashCode == FTPS_HASH) + { + return Protocol::FTPS; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if(overflowContainer) + { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast(hashCode); + } + + return Protocol::NOT_SET; + } + + Aws::String GetNameForProtocol(Protocol enumValue) + { + switch(enumValue) + { + case Protocol::SFTP: + return "SFTP"; + case Protocol::FTP: + return "FTP"; + case Protocol::FTPS: + return "FTPS"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if(overflowContainer) + { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } + } + + } // namespace ProtocolMapper + } // namespace Model + } // namespace Transfer +} // namespace Aws diff --git a/aws-cpp-sdk-awstransfer/source/model/TestIdentityProviderRequest.cpp b/aws-cpp-sdk-awstransfer/source/model/TestIdentityProviderRequest.cpp index a0ee599a26a..4045f32d61b 100644 --- a/aws-cpp-sdk-awstransfer/source/model/TestIdentityProviderRequest.cpp +++ b/aws-cpp-sdk-awstransfer/source/model/TestIdentityProviderRequest.cpp @@ -25,7 +25,9 @@ using namespace Aws::Utils; TestIdentityProviderRequest::TestIdentityProviderRequest() : m_serverIdHasBeenSet(false), m_userNameHasBeenSet(false), - m_userPasswordHasBeenSet(false) + m_userPasswordHasBeenSet(false), + m_serverProtocol(Protocol::NOT_SET), + m_serverProtocolHasBeenSet(false) { } @@ -51,6 +53,11 @@ Aws::String TestIdentityProviderRequest::SerializePayload() const } + if(m_serverProtocolHasBeenSet) + { + payload.WithString("ServerProtocol", ProtocolMapper::GetNameForProtocol(m_serverProtocol)); + } + return payload.View().WriteReadable(); } diff --git a/aws-cpp-sdk-awstransfer/source/model/UpdateServerRequest.cpp b/aws-cpp-sdk-awstransfer/source/model/UpdateServerRequest.cpp index 2d129dfb487..c7530ba01b6 100644 --- a/aws-cpp-sdk-awstransfer/source/model/UpdateServerRequest.cpp +++ b/aws-cpp-sdk-awstransfer/source/model/UpdateServerRequest.cpp @@ -23,12 +23,14 @@ using namespace Aws::Utils::Json; using namespace Aws::Utils; UpdateServerRequest::UpdateServerRequest() : + m_certificateHasBeenSet(false), m_endpointDetailsHasBeenSet(false), m_endpointType(EndpointType::NOT_SET), m_endpointTypeHasBeenSet(false), m_hostKeyHasBeenSet(false), m_identityProviderDetailsHasBeenSet(false), m_loggingRoleHasBeenSet(false), + m_protocolsHasBeenSet(false), m_serverIdHasBeenSet(false) { } @@ -37,6 +39,12 @@ Aws::String UpdateServerRequest::SerializePayload() const { JsonValue payload; + if(m_certificateHasBeenSet) + { + payload.WithString("Certificate", m_certificate); + + } + if(m_endpointDetailsHasBeenSet) { payload.WithObject("EndpointDetails", m_endpointDetails.Jsonize()); @@ -66,6 +74,17 @@ Aws::String UpdateServerRequest::SerializePayload() const } + if(m_protocolsHasBeenSet) + { + Array protocolsJsonList(m_protocols.size()); + for(unsigned protocolsIndex = 0; protocolsIndex < protocolsJsonList.GetLength(); ++protocolsIndex) + { + protocolsJsonList[protocolsIndex].AsString(ProtocolMapper::GetNameForProtocol(m_protocols[protocolsIndex])); + } + payload.WithArray("Protocols", std::move(protocolsJsonList)); + + } + if(m_serverIdHasBeenSet) { payload.WithString("ServerId", m_serverId); diff --git a/aws-cpp-sdk-core/include/aws/core/VersionConfig.h b/aws-cpp-sdk-core/include/aws/core/VersionConfig.h index f7113ddcc4d..d655d9f421a 100644 --- a/aws-cpp-sdk-core/include/aws/core/VersionConfig.h +++ b/aws-cpp-sdk-core/include/aws/core/VersionConfig.h @@ -13,4 +13,4 @@ * permissions and limitations under the License. */ -#define AWS_SDK_VERSION_STRING "1.7.319" +#define AWS_SDK_VERSION_STRING "1.7.320" diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/FirehoseClient.h b/aws-cpp-sdk-firehose/include/aws/firehose/FirehoseClient.h index 2d01c658e36..3bf21abc3f2 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/FirehoseClient.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/FirehoseClient.h @@ -879,17 +879,22 @@ namespace Model * respectively.

    To check the encryption status of a delivery stream, use * DescribeDeliveryStream.

    Even if encryption is currently enabled * for a delivery stream, you can still invoke this operation on it to change the - * ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose - * schedules the grant it had on the old CMK for retirement and creates a grant - * that enables it to use the new CMK to encrypt and decrypt data and to manage the - * grant.

    If a delivery stream already has encryption enabled and then you - * invoke this operation to change the ARN of the CMK or both its type and ARN and - * you get ENABLING_FAILED, this only means that the attempt to change - * the CMK failed. In this case, encryption remains enabled with the old CMK.

    - *

    If the encryption status of your delivery stream is - * ENABLING_FAILED, you can invoke this operation again.

    You - * can only enable SSE for a delivery stream that uses DirectPut as - * its source.

    The StartDeliveryStreamEncryption and + * ARN of the CMK or both its type and ARN. If you invoke this method to change the + * CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data + * Firehose schedules the grant it had on the old CMK for retirement. If the new + * CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates + * a grant that enables it to use the new CMK to encrypt and decrypt data and to + * manage the grant.

    If a delivery stream already has encryption enabled and + * then you invoke this operation to change the ARN of the CMK or both its type and + * ARN and you get ENABLING_FAILED, this only means that the attempt + * to change the CMK failed. In this case, encryption remains enabled with the old + * CMK.

    If the encryption status of your delivery stream is + * ENABLING_FAILED, you can invoke this operation again with a valid + * CMK. The CMK must be enabled and the key policy mustn't explicitly deny the + * permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt + * operations.

    You can enable SSE for a delivery stream only if it's a + * delivery stream that uses DirectPut as its source.

    The + * StartDeliveryStreamEncryption and * StopDeliveryStreamEncryption operations have a combined limit of 25 * calls per delivery stream per 24 hours. For example, you reach the limit if you * call StartDeliveryStreamEncryption 13 times and @@ -917,17 +922,22 @@ namespace Model * respectively.

    To check the encryption status of a delivery stream, use * DescribeDeliveryStream.

    Even if encryption is currently enabled * for a delivery stream, you can still invoke this operation on it to change the - * ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose - * schedules the grant it had on the old CMK for retirement and creates a grant - * that enables it to use the new CMK to encrypt and decrypt data and to manage the - * grant.

    If a delivery stream already has encryption enabled and then you - * invoke this operation to change the ARN of the CMK or both its type and ARN and - * you get ENABLING_FAILED, this only means that the attempt to change - * the CMK failed. In this case, encryption remains enabled with the old CMK.

    - *

    If the encryption status of your delivery stream is - * ENABLING_FAILED, you can invoke this operation again.

    You - * can only enable SSE for a delivery stream that uses DirectPut as - * its source.

    The StartDeliveryStreamEncryption and + * ARN of the CMK or both its type and ARN. If you invoke this method to change the + * CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data + * Firehose schedules the grant it had on the old CMK for retirement. If the new + * CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates + * a grant that enables it to use the new CMK to encrypt and decrypt data and to + * manage the grant.

    If a delivery stream already has encryption enabled and + * then you invoke this operation to change the ARN of the CMK or both its type and + * ARN and you get ENABLING_FAILED, this only means that the attempt + * to change the CMK failed. In this case, encryption remains enabled with the old + * CMK.

    If the encryption status of your delivery stream is + * ENABLING_FAILED, you can invoke this operation again with a valid + * CMK. The CMK must be enabled and the key policy mustn't explicitly deny the + * permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt + * operations.

    You can enable SSE for a delivery stream only if it's a + * delivery stream that uses DirectPut as its source.

    The + * StartDeliveryStreamEncryption and * StopDeliveryStreamEncryption operations have a combined limit of 25 * calls per delivery stream per 24 hours. For example, you reach the limit if you * call StartDeliveryStreamEncryption 13 times and @@ -957,17 +967,22 @@ namespace Model * respectively.

    To check the encryption status of a delivery stream, use * DescribeDeliveryStream.

    Even if encryption is currently enabled * for a delivery stream, you can still invoke this operation on it to change the - * ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose - * schedules the grant it had on the old CMK for retirement and creates a grant - * that enables it to use the new CMK to encrypt and decrypt data and to manage the - * grant.

    If a delivery stream already has encryption enabled and then you - * invoke this operation to change the ARN of the CMK or both its type and ARN and - * you get ENABLING_FAILED, this only means that the attempt to change - * the CMK failed. In this case, encryption remains enabled with the old CMK.

    - *

    If the encryption status of your delivery stream is - * ENABLING_FAILED, you can invoke this operation again.

    You - * can only enable SSE for a delivery stream that uses DirectPut as - * its source.

    The StartDeliveryStreamEncryption and + * ARN of the CMK or both its type and ARN. If you invoke this method to change the + * CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data + * Firehose schedules the grant it had on the old CMK for retirement. If the new + * CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates + * a grant that enables it to use the new CMK to encrypt and decrypt data and to + * manage the grant.

    If a delivery stream already has encryption enabled and + * then you invoke this operation to change the ARN of the CMK or both its type and + * ARN and you get ENABLING_FAILED, this only means that the attempt + * to change the CMK failed. In this case, encryption remains enabled with the old + * CMK.

    If the encryption status of your delivery stream is + * ENABLING_FAILED, you can invoke this operation again with a valid + * CMK. The CMK must be enabled and the key policy mustn't explicitly deny the + * permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt + * operations.

    You can enable SSE for a delivery stream only if it's a + * delivery stream that uses DirectPut as its source.

    The + * StartDeliveryStreamEncryption and * StopDeliveryStreamEncryption operations have a combined limit of 25 * calls per delivery stream per 24 hours. For example, you reach the limit if you * call StartDeliveryStreamEncryption 13 times and diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/CompressionFormat.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/CompressionFormat.h index 50a063a8a62..379b54948ce 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/CompressionFormat.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/CompressionFormat.h @@ -29,7 +29,8 @@ namespace Model UNCOMPRESSED, GZIP, ZIP, - Snappy + Snappy, + HADOOP_SNAPPY }; namespace CompressionFormatMapper diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/DataFormatConversionConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/DataFormatConversionConfiguration.h index eff07fd4a9c..42b3196e345 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/DataFormatConversionConfiguration.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/DataFormatConversionConfiguration.h @@ -58,111 +58,129 @@ namespace Model /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline const SchemaConfiguration& GetSchemaConfiguration() const{ return m_schemaConfiguration; } /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline bool SchemaConfigurationHasBeenSet() const { return m_schemaConfigurationHasBeenSet; } /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline void SetSchemaConfiguration(const SchemaConfiguration& value) { m_schemaConfigurationHasBeenSet = true; m_schemaConfiguration = value; } /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline void SetSchemaConfiguration(SchemaConfiguration&& value) { m_schemaConfigurationHasBeenSet = true; m_schemaConfiguration = std::move(value); } /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline DataFormatConversionConfiguration& WithSchemaConfiguration(const SchemaConfiguration& value) { SetSchemaConfiguration(value); return *this;} /** *

    Specifies the AWS Glue Data Catalog table that contains the column - * information.

    + * information. This parameter is required if Enabled is set to + * true.

    */ inline DataFormatConversionConfiguration& WithSchemaConfiguration(SchemaConfiguration&& value) { SetSchemaConfiguration(std::move(value)); return *this;} /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline const InputFormatConfiguration& GetInputFormatConfiguration() const{ return m_inputFormatConfiguration; } /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline bool InputFormatConfigurationHasBeenSet() const { return m_inputFormatConfigurationHasBeenSet; } /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline void SetInputFormatConfiguration(const InputFormatConfiguration& value) { m_inputFormatConfigurationHasBeenSet = true; m_inputFormatConfiguration = value; } /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline void SetInputFormatConfiguration(InputFormatConfiguration&& value) { m_inputFormatConfigurationHasBeenSet = true; m_inputFormatConfiguration = std::move(value); } /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline DataFormatConversionConfiguration& WithInputFormatConfiguration(const InputFormatConfiguration& value) { SetInputFormatConfiguration(value); return *this;} /** *

    Specifies the deserializer that you want Kinesis Data Firehose to use to - * convert the format of your data from JSON.

    + * convert the format of your data from JSON. This parameter is required if + * Enabled is set to true.

    */ inline DataFormatConversionConfiguration& WithInputFormatConfiguration(InputFormatConfiguration&& value) { SetInputFormatConfiguration(std::move(value)); return *this;} /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline const OutputFormatConfiguration& GetOutputFormatConfiguration() const{ return m_outputFormatConfiguration; } /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline bool OutputFormatConfigurationHasBeenSet() const { return m_outputFormatConfigurationHasBeenSet; } /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline void SetOutputFormatConfiguration(const OutputFormatConfiguration& value) { m_outputFormatConfigurationHasBeenSet = true; m_outputFormatConfiguration = value; } /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline void SetOutputFormatConfiguration(OutputFormatConfiguration&& value) { m_outputFormatConfigurationHasBeenSet = true; m_outputFormatConfiguration = std::move(value); } /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline DataFormatConversionConfiguration& WithOutputFormatConfiguration(const OutputFormatConfiguration& value) { SetOutputFormatConfiguration(value); return *this;} /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data to the Parquet or ORC format.

    + * convert the format of your data to the Parquet or ORC format. This parameter is + * required if Enabled is set to true.

    */ inline DataFormatConversionConfiguration& WithOutputFormatConfiguration(OutputFormatConfiguration&& value) { SetOutputFormatConfiguration(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamEncryptionConfigurationInput.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamEncryptionConfigurationInput.h index 32db9407ab2..8fff92ef13d 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamEncryptionConfigurationInput.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamEncryptionConfigurationInput.h @@ -35,7 +35,7 @@ namespace Model { /** - *

    Used to specify the type and Amazon Resource Name (ARN) of the CMK needed for + *

    Specifies the type and Amazon Resource Name (ARN) of the CMK to use for * Server-Side Encryption (SSE).

    See Also:

    AWS * API Reference

    @@ -126,9 +126,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline const KeyType& GetKeyType() const{ return m_keyType; } @@ -144,9 +153,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline bool KeyTypeHasBeenSet() const { return m_keyTypeHasBeenSet; } @@ -162,9 +180,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline void SetKeyType(const KeyType& value) { m_keyTypeHasBeenSet = true; m_keyType = value; } @@ -180,9 +207,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline void SetKeyType(KeyType&& value) { m_keyTypeHasBeenSet = true; m_keyType = std::move(value); } @@ -198,9 +234,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline DeliveryStreamEncryptionConfigurationInput& WithKeyType(const KeyType& value) { SetKeyType(value); return *this;} @@ -216,9 +261,18 @@ namespace Model * to create a grant that allows the Kinesis Data Firehose service to use the * customer managed CMK to perform encryption and decryption. Kinesis Data Firehose * manages that grant.

    When you invoke StartDeliveryStreamEncryption - * to change the CMK for a delivery stream that is already encrypted with a - * customer managed CMK, Kinesis Data Firehose schedules the grant it had on the - * old CMK for retirement.

    + * to change the CMK for a delivery stream that is encrypted with a customer + * managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for + * retirement.

    You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up + * to 500 delivery streams. If a CreateDeliveryStream or + * StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data + * Firehose throws a LimitExceededException.

    To + * encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't + * support asymmetric CMKs. For information about symmetric and asymmetric CMKs, + * see About + * Symmetric and Asymmetric CMKs in the AWS Key Management Service developer + * guide.

     */ inline DeliveryStreamEncryptionConfigurationInput& WithKeyType(KeyType&& value) { SetKeyType(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamFailureType.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamFailureType.h index 9372ec67952..9f415ec3d22 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamFailureType.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/DeliveryStreamFailureType.h @@ -33,6 +33,13 @@ namespace Model INVALID_KMS_KEY, KMS_KEY_NOT_FOUND, KMS_OPT_IN_REQUIRED, + CREATE_ENI_FAILED, + DELETE_ENI_FAILED, + SUBNET_NOT_FOUND, + SECURITY_GROUP_NOT_FOUND, + ENI_ACCESS_DENIED, + SUBNET_ACCESS_DENIED, + SECURITY_GROUP_ACCESS_DENIED, UNKNOWN_ERROR }; diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationConfiguration.h index 8a91f975524..336e6970e24 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationConfiguration.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationConfiguration.h @@ -23,6 +23,7 @@ #include #include #include +#include #include namespace Aws @@ -714,6 +715,37 @@ namespace Model */ inline ElasticsearchDestinationConfiguration& WithCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { SetCloudWatchLoggingOptions(std::move(value)); return *this;} + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline const VpcConfiguration& GetVpcConfiguration() const{ return m_vpcConfiguration; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline bool VpcConfigurationHasBeenSet() const { return m_vpcConfigurationHasBeenSet; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline void SetVpcConfiguration(const VpcConfiguration& value) { m_vpcConfigurationHasBeenSet = true; m_vpcConfiguration = value; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline void SetVpcConfiguration(VpcConfiguration&& value) { m_vpcConfigurationHasBeenSet = true; m_vpcConfiguration = std::move(value); } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline ElasticsearchDestinationConfiguration& WithVpcConfiguration(const VpcConfiguration& value) { SetVpcConfiguration(value); return *this;} + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline ElasticsearchDestinationConfiguration& WithVpcConfiguration(VpcConfiguration&& value) { SetVpcConfiguration(std::move(value)); return *this;} + private: Aws::String m_roleARN; @@ -751,6 +783,9 @@ namespace Model CloudWatchLoggingOptions m_cloudWatchLoggingOptions; bool m_cloudWatchLoggingOptionsHasBeenSet; + + VpcConfiguration m_vpcConfiguration; + bool m_vpcConfigurationHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationDescription.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationDescription.h index 5e2183db142..b6be2be9e8f 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationDescription.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/ElasticsearchDestinationDescription.h @@ -23,6 +23,7 @@ #include #include #include +#include #include namespace Aws @@ -555,6 +556,37 @@ namespace Model */ inline ElasticsearchDestinationDescription& WithCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { SetCloudWatchLoggingOptions(std::move(value)); return *this;} + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline const VpcConfigurationDescription& GetVpcConfigurationDescription() const{ return m_vpcConfigurationDescription; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline bool VpcConfigurationDescriptionHasBeenSet() const { return m_vpcConfigurationDescriptionHasBeenSet; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline void SetVpcConfigurationDescription(const VpcConfigurationDescription& value) { m_vpcConfigurationDescriptionHasBeenSet = true; m_vpcConfigurationDescription = value; } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline void SetVpcConfigurationDescription(VpcConfigurationDescription&& value) { m_vpcConfigurationDescriptionHasBeenSet = true; m_vpcConfigurationDescription = std::move(value); } + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline ElasticsearchDestinationDescription& WithVpcConfigurationDescription(const VpcConfigurationDescription& value) { SetVpcConfigurationDescription(value); return *this;} + + /** + *

    The details of the VPC of the Amazon ES destination.

    + */ + inline ElasticsearchDestinationDescription& WithVpcConfigurationDescription(VpcConfigurationDescription&& value) { SetVpcConfigurationDescription(std::move(value)); return *this;} + private: Aws::String m_roleARN; @@ -592,6 +624,9 @@ namespace Model CloudWatchLoggingOptions m_cloudWatchLoggingOptions; bool m_cloudWatchLoggingOptionsHasBeenSet; + + VpcConfigurationDescription m_vpcConfigurationDescription; + bool m_vpcConfigurationDescriptionHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/InputFormatConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/InputFormatConfiguration.h index bbd3c8b478e..1176a553aaf 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/InputFormatConfiguration.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/InputFormatConfiguration.h @@ -35,7 +35,8 @@ namespace Model /** *

    Specifies the deserializer you want to use to convert the format of the input - * data.

    See Also:

    Enabled     is set to + * true.

    See Also:

    AWS * API Reference

    */ diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/OutputFormatConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/OutputFormatConfiguration.h index f0b4cf31a4e..90729713a3b 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/OutputFormatConfiguration.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/OutputFormatConfiguration.h @@ -35,8 +35,9 @@ namespace Model /** *

    Specifies the serializer that you want Kinesis Data Firehose to use to - * convert the format of your data before it writes it to Amazon S3.

    See - * Also:

    Enabled     is set to true.

    See Also:

    + *     AWS * API Reference

    */ diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/SchemaConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/SchemaConfiguration.h index f293c83c1bd..6a452fd06ca 100644 --- a/aws-cpp-sdk-firehose/include/aws/firehose/model/SchemaConfiguration.h +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/SchemaConfiguration.h @@ -35,7 +35,8 @@ namespace Model /** *

    Specifies the schema to which you want Kinesis Data Firehose to configure - * your data before it writes it to Amazon S3.

    See Also:

    Enabled is set to true.

    See Also:

    AWS * API Reference

    */ diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfiguration.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfiguration.h new file mode 100644 index 00000000000..b8dc215563a --- /dev/null +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfiguration.h @@ -0,0 +1,332 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace Firehose +{ +namespace Model +{ + + /** + *

    The details of the VPC of the Amazon ES destination.

    See Also:

    + * AWS + * API Reference

    + */ + class AWS_FIREHOSE_API VpcConfiguration + { + public: + VpcConfiguration(); + VpcConfiguration(Aws::Utils::Json::JsonView jsonValue); + VpcConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfiguration& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfiguration& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfiguration& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfiguration& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } + + /** + *

    The IDs of the subnets that you want Kinesis Data Firehose to use to create + * ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables + * and inbound and outbound rules allow traffic to flow from the subnets whose IDs + * are specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfiguration& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } + + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline const Aws::String& GetRoleARN() const{ return m_roleARN; } + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline VpcConfiguration& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline VpcConfiguration& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} + + /** + *

    The ARN of the IAM role that you want the delivery stream to use to create + * endpoints in the destination VPC.

    + */ + inline VpcConfiguration& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} + + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline const Aws::Vector& GetSecurityGroupIds() const{ return m_securityGroupIds; } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline bool SecurityGroupIdsHasBeenSet() const { return m_securityGroupIdsHasBeenSet; } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline void SetSecurityGroupIds(const Aws::Vector& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds = value; } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline void SetSecurityGroupIds(Aws::Vector&& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds = std::move(value); } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfiguration& WithSecurityGroupIds(const Aws::Vector& value) { SetSecurityGroupIds(value); return *this;} + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfiguration& WithSecurityGroupIds(Aws::Vector&& value) { SetSecurityGroupIds(std::move(value)); return *this;} + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfiguration& AddSecurityGroupIds(const Aws::String& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(value); return *this; } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfiguration& AddSecurityGroupIds(Aws::String&& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(std::move(value)); return *this; } + + /** + *

    The IDs of the security groups that you want Kinesis Data Firehose to use + * when it creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfiguration& AddSecurityGroupIds(const char* value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(value); return *this; } + + private: + + Aws::Vector m_subnetIds; + bool m_subnetIdsHasBeenSet; + + Aws::String m_roleARN; + bool m_roleARNHasBeenSet; + + Aws::Vector m_securityGroupIds; + bool m_securityGroupIdsHasBeenSet; + }; + +} // namespace Model +} // namespace Firehose +} // namespace Aws diff --git a/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfigurationDescription.h b/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfigurationDescription.h new file mode 100644 index 00000000000..53931715b42 --- /dev/null +++ b/aws-cpp-sdk-firehose/include/aws/firehose/model/VpcConfigurationDescription.h @@ -0,0 +1,376 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace Firehose +{ +namespace Model +{ + + /** + *

    The details of the VPC of the Amazon ES destination.

    See Also:

    + * AWS + * API Reference

    + */ + class AWS_FIREHOSE_API VpcConfigurationDescription + { + public: + VpcConfigurationDescription(); + VpcConfigurationDescription(Aws::Utils::Json::JsonView jsonValue); + VpcConfigurationDescription& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfigurationDescription& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfigurationDescription& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfigurationDescription& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfigurationDescription& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } + + /** + *

    The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the + * VPC of the Amazon ES destination. Make sure that the routing tables and inbound + * and outbound rules allow traffic to flow from the subnets whose IDs are + * specified here to the subnets that have the destination Amazon ES endpoints. + * Kinesis Data Firehose creates at least one ENI in each of the subnets that are + * specified here. Do not delete or modify these ENIs.

    The number of ENIs + * that Kinesis Data Firehose creates in the subnets specified here scales up and + * down automatically based on throughput. To enable Kinesis Data Firehose to scale + * up the number of ENIs to match throughput, ensure that you have sufficient + * quota. To help you calculate the quota you need, assume that Kinesis Data + * Firehose can create up to three ENIs for this delivery stream for each of the + * subnets specified here. For more information about ENI quota, see Network + * Interfaces in the Amazon VPC Quotas topic.

    + */ + inline VpcConfigurationDescription& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } + + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline const Aws::String& GetRoleARN() const{ return m_roleARN; } + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline VpcConfigurationDescription& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline VpcConfigurationDescription& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} + + /** + *

    The ARN of the IAM role that you want the delivery stream uses to create + * endpoints in the destination VPC.

    + */ + inline VpcConfigurationDescription& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} + + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline const Aws::Vector& GetSecurityGroupIds() const{ return m_securityGroupIds; } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline bool SecurityGroupIdsHasBeenSet() const { return m_securityGroupIdsHasBeenSet; } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline void SetSecurityGroupIds(const Aws::Vector& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds = value; } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline void SetSecurityGroupIds(Aws::Vector&& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds = std::move(value); } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfigurationDescription& WithSecurityGroupIds(const Aws::Vector& value) { SetSecurityGroupIds(value); return *this;} + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfigurationDescription& WithSecurityGroupIds(Aws::Vector&& value) { SetSecurityGroupIds(std::move(value)); return *this;} + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfigurationDescription& AddSecurityGroupIds(const Aws::String& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(value); return *this; } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfigurationDescription& AddSecurityGroupIds(Aws::String&& value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(std::move(value)); return *this; } + + /** + *

    The IDs of the security groups that Kinesis Data Firehose uses when it + * creates ENIs in the VPC of the Amazon ES destination.

    + */ + inline VpcConfigurationDescription& AddSecurityGroupIds(const char* value) { m_securityGroupIdsHasBeenSet = true; m_securityGroupIds.push_back(value); return *this; } + + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline const Aws::String& GetVpcId() const{ return m_vpcId; } + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline bool VpcIdHasBeenSet() const { return m_vpcIdHasBeenSet; } + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline void SetVpcId(const Aws::String& value) { m_vpcIdHasBeenSet = true; m_vpcId = value; } + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline void SetVpcId(Aws::String&& value) { m_vpcIdHasBeenSet = true; m_vpcId = std::move(value); } + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline void SetVpcId(const char* value) { m_vpcIdHasBeenSet = true; m_vpcId.assign(value); } + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline VpcConfigurationDescription& WithVpcId(const Aws::String& value) { SetVpcId(value); return *this;} + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline VpcConfigurationDescription& WithVpcId(Aws::String&& value) { SetVpcId(std::move(value)); return *this;} + + /** + *

    The ID of the Amazon ES destination's VPC.

    + */ + inline VpcConfigurationDescription& WithVpcId(const char* value) { SetVpcId(value); return *this;} + + private: + + Aws::Vector m_subnetIds; + bool m_subnetIdsHasBeenSet; + + Aws::String m_roleARN; + bool m_roleARNHasBeenSet; + + Aws::Vector m_securityGroupIds; + bool m_securityGroupIdsHasBeenSet; + + Aws::String m_vpcId; + bool m_vpcIdHasBeenSet; + }; + +} // namespace Model +} // namespace Firehose +} // namespace Aws diff --git a/aws-cpp-sdk-firehose/source/model/CompressionFormat.cpp b/aws-cpp-sdk-firehose/source/model/CompressionFormat.cpp index 63e6486890c..24c9b6f1adf 100644 --- a/aws-cpp-sdk-firehose/source/model/CompressionFormat.cpp +++ b/aws-cpp-sdk-firehose/source/model/CompressionFormat.cpp @@ -34,6 +34,7 @@ namespace Aws static const int GZIP_HASH = HashingUtils::HashString("GZIP"); static const int ZIP_HASH = HashingUtils::HashString("ZIP"); static const int Snappy_HASH = HashingUtils::HashString("Snappy"); + static const int HADOOP_SNAPPY_HASH = HashingUtils::HashString("HADOOP_SNAPPY"); CompressionFormat GetCompressionFormatForName(const Aws::String& name) @@ -55,6 +56,10 @@ namespace Aws { return CompressionFormat::Snappy; } + else if (hashCode == HADOOP_SNAPPY_HASH) + { + return CompressionFormat::HADOOP_SNAPPY; + } EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) { @@ -77,6 +82,8 @@ namespace Aws return "ZIP"; case CompressionFormat::Snappy: return "Snappy"; + case CompressionFormat::HADOOP_SNAPPY: + return "HADOOP_SNAPPY"; default: EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); if(overflowContainer) diff --git a/aws-cpp-sdk-firehose/source/model/DeliveryStreamFailureType.cpp b/aws-cpp-sdk-firehose/source/model/DeliveryStreamFailureType.cpp index 3bd80648d96..f8ad74a56ad 100644 --- a/aws-cpp-sdk-firehose/source/model/DeliveryStreamFailureType.cpp +++ b/aws-cpp-sdk-firehose/source/model/DeliveryStreamFailureType.cpp @@ -37,6 +37,13 @@ namespace Aws static const int INVALID_KMS_KEY_HASH = HashingUtils::HashString("INVALID_KMS_KEY"); static const int KMS_KEY_NOT_FOUND_HASH = HashingUtils::HashString("KMS_KEY_NOT_FOUND"); static const int KMS_OPT_IN_REQUIRED_HASH = HashingUtils::HashString("KMS_OPT_IN_REQUIRED"); + static const int CREATE_ENI_FAILED_HASH = HashingUtils::HashString("CREATE_ENI_FAILED"); + static const int DELETE_ENI_FAILED_HASH = HashingUtils::HashString("DELETE_ENI_FAILED"); + static const int SUBNET_NOT_FOUND_HASH = HashingUtils::HashString("SUBNET_NOT_FOUND"); + static const int SECURITY_GROUP_NOT_FOUND_HASH = HashingUtils::HashString("SECURITY_GROUP_NOT_FOUND"); + static const int ENI_ACCESS_DENIED_HASH = HashingUtils::HashString("ENI_ACCESS_DENIED"); + static const int SUBNET_ACCESS_DENIED_HASH = HashingUtils::HashString("SUBNET_ACCESS_DENIED"); + static const int SECURITY_GROUP_ACCESS_DENIED_HASH = HashingUtils::HashString("SECURITY_GROUP_ACCESS_DENIED"); static const int UNKNOWN_ERROR_HASH = HashingUtils::HashString("UNKNOWN_ERROR"); @@ -71,6 +78,34 @@ namespace Aws { return DeliveryStreamFailureType::KMS_OPT_IN_REQUIRED; } + else if (hashCode == CREATE_ENI_FAILED_HASH) + { + return DeliveryStreamFailureType::CREATE_ENI_FAILED; + } + else if (hashCode == DELETE_ENI_FAILED_HASH) + { + return DeliveryStreamFailureType::DELETE_ENI_FAILED; + } + else if (hashCode == SUBNET_NOT_FOUND_HASH) + { + return DeliveryStreamFailureType::SUBNET_NOT_FOUND; + } + else if (hashCode == SECURITY_GROUP_NOT_FOUND_HASH) + { + return DeliveryStreamFailureType::SECURITY_GROUP_NOT_FOUND; + } + else if (hashCode == ENI_ACCESS_DENIED_HASH) + { + return DeliveryStreamFailureType::ENI_ACCESS_DENIED; + } + else if (hashCode == SUBNET_ACCESS_DENIED_HASH) + { + return DeliveryStreamFailureType::SUBNET_ACCESS_DENIED; + } + else if (hashCode == SECURITY_GROUP_ACCESS_DENIED_HASH) + { + return DeliveryStreamFailureType::SECURITY_GROUP_ACCESS_DENIED; + } else if (hashCode == UNKNOWN_ERROR_HASH) { return DeliveryStreamFailureType::UNKNOWN_ERROR; @@ -103,6 +138,20 @@ namespace Aws return "KMS_KEY_NOT_FOUND"; case DeliveryStreamFailureType::KMS_OPT_IN_REQUIRED: return "KMS_OPT_IN_REQUIRED"; + case DeliveryStreamFailureType::CREATE_ENI_FAILED: + return "CREATE_ENI_FAILED"; + case DeliveryStreamFailureType::DELETE_ENI_FAILED: + return "DELETE_ENI_FAILED"; + case DeliveryStreamFailureType::SUBNET_NOT_FOUND: + return "SUBNET_NOT_FOUND"; + case DeliveryStreamFailureType::SECURITY_GROUP_NOT_FOUND: + return "SECURITY_GROUP_NOT_FOUND"; + case DeliveryStreamFailureType::ENI_ACCESS_DENIED: + return "ENI_ACCESS_DENIED"; + case DeliveryStreamFailureType::SUBNET_ACCESS_DENIED: + return "SUBNET_ACCESS_DENIED"; + case DeliveryStreamFailureType::SECURITY_GROUP_ACCESS_DENIED: + return "SECURITY_GROUP_ACCESS_DENIED"; case DeliveryStreamFailureType::UNKNOWN_ERROR: return "UNKNOWN_ERROR"; default: diff --git a/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationConfiguration.cpp b/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationConfiguration.cpp index 1a42d501e84..6bdcb54d637 100644 --- a/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationConfiguration.cpp +++ b/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationConfiguration.cpp @@ -42,7 +42,8 @@ ElasticsearchDestinationConfiguration::ElasticsearchDestinationConfiguration() : m_s3BackupModeHasBeenSet(false), m_s3ConfigurationHasBeenSet(false), m_processingConfigurationHasBeenSet(false), - m_cloudWatchLoggingOptionsHasBeenSet(false) + m_cloudWatchLoggingOptionsHasBeenSet(false), + m_vpcConfigurationHasBeenSet(false) { } @@ -60,7 +61,8 @@ ElasticsearchDestinationConfiguration::ElasticsearchDestinationConfiguration(Jso m_s3BackupModeHasBeenSet(false), m_s3ConfigurationHasBeenSet(false), m_processingConfigurationHasBeenSet(false), - m_cloudWatchLoggingOptionsHasBeenSet(false) + m_cloudWatchLoggingOptionsHasBeenSet(false), + m_vpcConfigurationHasBeenSet(false) { *this = jsonValue; } @@ -151,6 +153,13 @@ ElasticsearchDestinationConfiguration& ElasticsearchDestinationConfiguration::op m_cloudWatchLoggingOptionsHasBeenSet = true; } + if(jsonValue.ValueExists("VpcConfiguration")) + { + m_vpcConfiguration = jsonValue.GetObject("VpcConfiguration"); + + m_vpcConfigurationHasBeenSet = true; + } + return *this; } @@ -228,6 +237,12 @@ JsonValue ElasticsearchDestinationConfiguration::Jsonize() const } + if(m_vpcConfigurationHasBeenSet) + { + payload.WithObject("VpcConfiguration", m_vpcConfiguration.Jsonize()); + + } + return payload; } diff --git a/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationDescription.cpp b/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationDescription.cpp index 8dd62aaf93a..8250ccd180c 100644 --- a/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationDescription.cpp +++ b/aws-cpp-sdk-firehose/source/model/ElasticsearchDestinationDescription.cpp @@ -42,7 +42,8 @@ ElasticsearchDestinationDescription::ElasticsearchDestinationDescription() : m_s3BackupModeHasBeenSet(false), m_s3DestinationDescriptionHasBeenSet(false), m_processingConfigurationHasBeenSet(false), - m_cloudWatchLoggingOptionsHasBeenSet(false) + m_cloudWatchLoggingOptionsHasBeenSet(false), + m_vpcConfigurationDescriptionHasBeenSet(false) { } @@ -60,7 +61,8 @@ ElasticsearchDestinationDescription::ElasticsearchDestinationDescription(JsonVie m_s3BackupModeHasBeenSet(false), m_s3DestinationDescriptionHasBeenSet(false), m_processingConfigurationHasBeenSet(false), - m_cloudWatchLoggingOptionsHasBeenSet(false) + m_cloudWatchLoggingOptionsHasBeenSet(false), + m_vpcConfigurationDescriptionHasBeenSet(false) { *this = jsonValue; } @@ -151,6 +153,13 @@ ElasticsearchDestinationDescription& ElasticsearchDestinationDescription::operat m_cloudWatchLoggingOptionsHasBeenSet = true; } + if(jsonValue.ValueExists("VpcConfigurationDescription")) + { + m_vpcConfigurationDescription = jsonValue.GetObject("VpcConfigurationDescription"); + + m_vpcConfigurationDescriptionHasBeenSet = true; + } + return *this; } @@ -228,6 +237,12 @@ JsonValue ElasticsearchDestinationDescription::Jsonize() const } + if(m_vpcConfigurationDescriptionHasBeenSet) + { + payload.WithObject("VpcConfigurationDescription", m_vpcConfigurationDescription.Jsonize()); + + } + return payload; } diff --git a/aws-cpp-sdk-firehose/source/model/VpcConfiguration.cpp b/aws-cpp-sdk-firehose/source/model/VpcConfiguration.cpp new file mode 100644 index 00000000000..77d6d2928ec --- /dev/null +++ b/aws-cpp-sdk-firehose/source/model/VpcConfiguration.cpp @@ -0,0 +1,115 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace Firehose +{ +namespace Model +{ + +VpcConfiguration::VpcConfiguration() : + m_subnetIdsHasBeenSet(false), + m_roleARNHasBeenSet(false), + m_securityGroupIdsHasBeenSet(false) +{ +} + +VpcConfiguration::VpcConfiguration(JsonView jsonValue) : + m_subnetIdsHasBeenSet(false), + m_roleARNHasBeenSet(false), + m_securityGroupIdsHasBeenSet(false) +{ + *this = jsonValue; +} + +VpcConfiguration& VpcConfiguration::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("SubnetIds")) + { + Array subnetIdsJsonList = jsonValue.GetArray("SubnetIds"); + for(unsigned subnetIdsIndex = 0; subnetIdsIndex < subnetIdsJsonList.GetLength(); ++subnetIdsIndex) + { + m_subnetIds.push_back(subnetIdsJsonList[subnetIdsIndex].AsString()); + } + m_subnetIdsHasBeenSet = true; + } + + if(jsonValue.ValueExists("RoleARN")) + { + m_roleARN = jsonValue.GetString("RoleARN"); + + m_roleARNHasBeenSet = true; + } + + if(jsonValue.ValueExists("SecurityGroupIds")) + { + Array securityGroupIdsJsonList = jsonValue.GetArray("SecurityGroupIds"); + for(unsigned securityGroupIdsIndex = 0; securityGroupIdsIndex < securityGroupIdsJsonList.GetLength(); ++securityGroupIdsIndex) + { + m_securityGroupIds.push_back(securityGroupIdsJsonList[securityGroupIdsIndex].AsString()); + } + m_securityGroupIdsHasBeenSet = true; + } + + return *this; +} + +JsonValue VpcConfiguration::Jsonize() const +{ + JsonValue payload; + + if(m_subnetIdsHasBeenSet) + { + Array subnetIdsJsonList(m_subnetIds.size()); + for(unsigned subnetIdsIndex = 0; subnetIdsIndex < subnetIdsJsonList.GetLength(); ++subnetIdsIndex) + { + subnetIdsJsonList[subnetIdsIndex].AsString(m_subnetIds[subnetIdsIndex]); + } + payload.WithArray("SubnetIds", std::move(subnetIdsJsonList)); + + } + + if(m_roleARNHasBeenSet) + { + payload.WithString("RoleARN", m_roleARN); + + } + + if(m_securityGroupIdsHasBeenSet) + { + Array securityGroupIdsJsonList(m_securityGroupIds.size()); + for(unsigned securityGroupIdsIndex = 0; securityGroupIdsIndex < securityGroupIdsJsonList.GetLength(); ++securityGroupIdsIndex) + { + securityGroupIdsJsonList[securityGroupIdsIndex].AsString(m_securityGroupIds[securityGroupIdsIndex]); + } + payload.WithArray("SecurityGroupIds", std::move(securityGroupIdsJsonList)); + + } + + return payload; +} + +} // namespace Model +} // namespace Firehose +} // namespace Aws diff --git a/aws-cpp-sdk-firehose/source/model/VpcConfigurationDescription.cpp b/aws-cpp-sdk-firehose/source/model/VpcConfigurationDescription.cpp new file mode 100644 index 00000000000..97737661b33 --- /dev/null +++ b/aws-cpp-sdk-firehose/source/model/VpcConfigurationDescription.cpp @@ -0,0 +1,130 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace Firehose +{ +namespace Model +{ + +VpcConfigurationDescription::VpcConfigurationDescription() : + m_subnetIdsHasBeenSet(false), + m_roleARNHasBeenSet(false), + m_securityGroupIdsHasBeenSet(false), + m_vpcIdHasBeenSet(false) +{ +} + +VpcConfigurationDescription::VpcConfigurationDescription(JsonView jsonValue) : + m_subnetIdsHasBeenSet(false), + m_roleARNHasBeenSet(false), + m_securityGroupIdsHasBeenSet(false), + m_vpcIdHasBeenSet(false) +{ + *this = jsonValue; +} + +VpcConfigurationDescription& VpcConfigurationDescription::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("SubnetIds")) + { + Array subnetIdsJsonList = jsonValue.GetArray("SubnetIds"); + for(unsigned subnetIdsIndex = 0; subnetIdsIndex < subnetIdsJsonList.GetLength(); ++subnetIdsIndex) + { + m_subnetIds.push_back(subnetIdsJsonList[subnetIdsIndex].AsString()); + } + m_subnetIdsHasBeenSet = true; + } + + if(jsonValue.ValueExists("RoleARN")) + { + m_roleARN = jsonValue.GetString("RoleARN"); + + m_roleARNHasBeenSet = true; + } + + if(jsonValue.ValueExists("SecurityGroupIds")) + { + Array securityGroupIdsJsonList = jsonValue.GetArray("SecurityGroupIds"); + for(unsigned securityGroupIdsIndex = 0; securityGroupIdsIndex < securityGroupIdsJsonList.GetLength(); ++securityGroupIdsIndex) + { + m_securityGroupIds.push_back(securityGroupIdsJsonList[securityGroupIdsIndex].AsString()); + } + m_securityGroupIdsHasBeenSet = true; + } + + if(jsonValue.ValueExists("VpcId")) + { + m_vpcId = jsonValue.GetString("VpcId"); + + m_vpcIdHasBeenSet = true; + } + + return *this; +} + +JsonValue VpcConfigurationDescription::Jsonize() const +{ + JsonValue payload; + + if(m_subnetIdsHasBeenSet) + { + Array subnetIdsJsonList(m_subnetIds.size()); + for(unsigned subnetIdsIndex = 0; subnetIdsIndex < subnetIdsJsonList.GetLength(); ++subnetIdsIndex) + { + subnetIdsJsonList[subnetIdsIndex].AsString(m_subnetIds[subnetIdsIndex]); + } + payload.WithArray("SubnetIds", std::move(subnetIdsJsonList)); + + } + + if(m_roleARNHasBeenSet) + { + payload.WithString("RoleARN", m_roleARN); + + } + + if(m_securityGroupIdsHasBeenSet) + { + Array securityGroupIdsJsonList(m_securityGroupIds.size()); + for(unsigned securityGroupIdsIndex = 0; securityGroupIdsIndex < securityGroupIdsJsonList.GetLength(); ++securityGroupIdsIndex) + { + securityGroupIdsJsonList[securityGroupIdsIndex].AsString(m_securityGroupIds[securityGroupIdsIndex]); + } + payload.WithArray("SecurityGroupIds", std::move(securityGroupIdsJsonList)); + + } + + if(m_vpcIdHasBeenSet) + { + payload.WithString("VpcId", m_vpcId); + + } + + return payload; +} + +} // namespace Model +} // namespace Firehose +} // namespace Aws diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/MediaPackageVodClient.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/MediaPackageVodClient.h index 66bd7813f40..1a9bc18a781 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/MediaPackageVodClient.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/MediaPackageVodClient.h @@ -33,6 +33,8 @@ #include #include #include +#include +#include #include #include #include @@ -84,6 +86,9 @@ namespace Model class ListAssetsRequest; class ListPackagingConfigurationsRequest; class ListPackagingGroupsRequest; + class ListTagsForResourceRequest; + class TagResourceRequest; + class UntagResourceRequest; typedef Aws::Utils::Outcome> CreateAssetOutcome; typedef Aws::Utils::Outcome> CreatePackagingConfigurationOutcome; @@ -97,6 +102,9 @@ namespace Model typedef Aws::Utils::Outcome> ListAssetsOutcome; typedef Aws::Utils::Outcome> ListPackagingConfigurationsOutcome; typedef Aws::Utils::Outcome> ListPackagingGroupsOutcome; + typedef Aws::Utils::Outcome> ListTagsForResourceOutcome; + typedef Aws::Utils::Outcome> TagResourceOutcome; + typedef Aws::Utils::Outcome> UntagResourceOutcome; typedef std::future CreateAssetOutcomeCallable; typedef std::future CreatePackagingConfigurationOutcomeCallable; @@ -110,6 +118,9 @@ namespace Model typedef std::future ListAssetsOutcomeCallable; typedef std::future ListPackagingConfigurationsOutcomeCallable; typedef std::future ListPackagingGroupsOutcomeCallable; + typedef std::future ListTagsForResourceOutcomeCallable; + typedef std::future TagResourceOutcomeCallable; + typedef std::future UntagResourceOutcomeCallable; } // namespace Model class MediaPackageVodClient; @@ -126,6 +137,9 @@ namespace Model typedef std::function&) > ListAssetsResponseReceivedHandler; typedef std::function&) > ListPackagingConfigurationsResponseReceivedHandler; typedef std::function&) > ListPackagingGroupsResponseReceivedHandler; + typedef std::function&) > ListTagsForResourceResponseReceivedHandler; + typedef std::function&) > TagResourceResponseReceivedHandler; + typedef std::function&) > UntagResourceResponseReceivedHandler; /** * AWS Elemental MediaPackage VOD @@ -486,6 +500,81 @@ namespace Model */ virtual void ListPackagingGroupsAsync(const Model::ListPackagingGroupsRequest& request, const ListPackagingGroupsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** + * List tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + */ + virtual Model::ListTagsForResourceOutcome ListTagsForResource(const Model::ListTagsForResourceRequest& request) const; + + /** + * List tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable(const Model::ListTagsForResourceRequest& request) const; + + /** + * List tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void ListTagsForResourceAsync(const Model::ListTagsForResourceRequest& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + + /** + * Set tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + */ + virtual Model::TagResourceOutcome TagResource(const Model::TagResourceRequest& request) const; + + /** + * Set tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::TagResourceOutcomeCallable TagResourceCallable(const Model::TagResourceRequest& request) const; + + /** + * Set tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void TagResourceAsync(const Model::TagResourceRequest& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + + /** + * Delete tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + */ + virtual Model::UntagResourceOutcome UntagResource(const Model::UntagResourceRequest& request) const; + + /** + * Delete tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::UntagResourceOutcomeCallable UntagResourceCallable(const Model::UntagResourceRequest& request) const; + + /** + * Delete tags for a given MediaPackage VOD resource

    See Also:

    AWS + * API Reference

    + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void UntagResourceAsync(const Model::UntagResourceRequest& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + void OverrideEndpoint(const Aws::String& endpoint); private: @@ -502,6 +591,9 @@ namespace Model void ListAssetsAsyncHelper(const Model::ListAssetsRequest& request, const ListAssetsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListPackagingConfigurationsAsyncHelper(const Model::ListPackagingConfigurationsRequest& request, const ListPackagingConfigurationsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListPackagingGroupsAsyncHelper(const Model::ListPackagingGroupsRequest& request, const ListPackagingGroupsResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void ListTagsForResourceAsyncHelper(const Model::ListTagsForResourceRequest& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void TagResourceAsyncHelper(const Model::TagResourceRequest& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void UntagResourceAsyncHelper(const Model::UntagResourceRequest& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const; Aws::String m_uri; Aws::String m_configScheme; diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/AssetShallow.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/AssetShallow.h index fb69079c6ad..3ec0321d747 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/AssetShallow.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/AssetShallow.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include namespace Aws @@ -333,6 +334,46 @@ namespace Model */ inline AssetShallow& WithSourceRoleArn(const char* value) { SetSourceRoleArn(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline AssetShallow& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline AssetShallow& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline AssetShallow& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline AssetShallow& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline AssetShallow& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline AssetShallow& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline AssetShallow& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline AssetShallow& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline AssetShallow& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -355,6 +396,9 @@ namespace Model Aws::String m_sourceRoleArn; bool m_sourceRoleArnHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetRequest.h index 1a5842548b2..80cf53fe87c 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetRequest.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetRequest.h @@ -17,6 +17,7 @@ #include #include #include +#include #include namespace Aws @@ -249,6 +250,46 @@ namespace Model */ inline CreateAssetRequest& WithSourceRoleArn(const char* value) { SetSourceRoleArn(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline CreateAssetRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreateAssetRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreateAssetRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline CreateAssetRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreateAssetRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreateAssetRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreateAssetRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreateAssetRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreateAssetRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: Aws::String m_id; @@ -265,6 +306,9 @@ namespace Model Aws::String m_sourceRoleArn; bool m_sourceRoleArnHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetResult.h index 9b0ef1b8636..0e8d0ccb64f 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreateAssetResult.h @@ -17,6 +17,7 @@ #include #include #include +#include #include #include @@ -331,6 +332,43 @@ namespace Model */ inline CreateAssetResult& WithSourceRoleArn(const char* value) { SetSourceRoleArn(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline CreateAssetResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreateAssetResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreateAssetResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline CreateAssetResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreateAssetResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreateAssetResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreateAssetResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreateAssetResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreateAssetResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -348,6 +386,8 @@ namespace Model Aws::String m_sourceArn; Aws::String m_sourceRoleArn; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationRequest.h index 30397ccd654..09222e6be88 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationRequest.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationRequest.h @@ -21,6 +21,7 @@ #include #include #include +#include #include namespace Aws @@ -207,6 +208,46 @@ namespace Model */ inline CreatePackagingConfigurationRequest& WithPackagingGroupId(const char* value) { SetPackagingGroupId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline CreatePackagingConfigurationRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreatePackagingConfigurationRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreatePackagingConfigurationRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingConfigurationRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: CmafPackage m_cmafPackage; @@ -226,6 +267,9 @@ namespace Model Aws::String m_packagingGroupId; bool m_packagingGroupIdHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationResult.h index b552bfa84cc..37df23652b7 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingConfigurationResult.h @@ -20,6 +20,7 @@ #include #include #include +#include #include namespace Aws @@ -217,6 +218,43 @@ namespace Model */ inline CreatePackagingConfigurationResult& WithPackagingGroupId(const char* value) { SetPackagingGroupId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline CreatePackagingConfigurationResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreatePackagingConfigurationResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreatePackagingConfigurationResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingConfigurationResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -232,6 +270,8 @@ namespace Model MssPackage m_mssPackage; Aws::String m_packagingGroupId; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupRequest.h index 7466ca71452..6f78a5cedc4 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupRequest.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupRequest.h @@ -17,6 +17,7 @@ #include #include #include +#include #include namespace Aws @@ -86,10 +87,53 @@ namespace Model */ inline CreatePackagingGroupRequest& WithId(const char* value) { SetId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline CreatePackagingGroupRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreatePackagingGroupRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreatePackagingGroupRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingGroupRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: Aws::String m_id; bool m_idHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupResult.h index 4d8237ce002..01222b83098 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/CreatePackagingGroupResult.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include namespace Aws @@ -149,6 +150,43 @@ namespace Model */ inline CreatePackagingGroupResult& WithId(const char* value) { SetId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline CreatePackagingGroupResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline CreatePackagingGroupResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline CreatePackagingGroupResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline CreatePackagingGroupResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingGroupResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingGroupResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline CreatePackagingGroupResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline CreatePackagingGroupResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline CreatePackagingGroupResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -156,6 +194,8 @@ namespace Model Aws::String m_domainName; Aws::String m_id; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribeAssetResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribeAssetResult.h index 1e3d9e3e18e..aab27bbaa5e 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribeAssetResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribeAssetResult.h @@ -17,6 +17,7 @@ #include #include #include +#include #include #include @@ -331,6 +332,43 @@ namespace Model */ inline DescribeAssetResult& WithSourceRoleArn(const char* value) { SetSourceRoleArn(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline DescribeAssetResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline DescribeAssetResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline DescribeAssetResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline DescribeAssetResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribeAssetResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribeAssetResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline DescribeAssetResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribeAssetResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribeAssetResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -348,6 +386,8 @@ namespace Model Aws::String m_sourceArn; Aws::String m_sourceRoleArn; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingConfigurationResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingConfigurationResult.h index a1c52464fee..09aae1751e2 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingConfigurationResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingConfigurationResult.h @@ -20,6 +20,7 @@ #include #include #include +#include #include namespace Aws @@ -217,6 +218,43 @@ namespace Model */ inline DescribePackagingConfigurationResult& WithPackagingGroupId(const char* value) { SetPackagingGroupId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline DescribePackagingConfigurationResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline DescribePackagingConfigurationResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline DescribePackagingConfigurationResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribePackagingConfigurationResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -232,6 +270,8 @@ namespace Model MssPackage m_mssPackage; Aws::String m_packagingGroupId; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingGroupResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingGroupResult.h index ab325bed6d7..3cbc7cb3d36 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingGroupResult.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/DescribePackagingGroupResult.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include namespace Aws @@ -149,6 +150,43 @@ namespace Model */ inline DescribePackagingGroupResult& WithId(const char* value) { SetId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline DescribePackagingGroupResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline DescribePackagingGroupResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline DescribePackagingGroupResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline DescribePackagingGroupResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribePackagingGroupResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribePackagingGroupResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline DescribePackagingGroupResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline DescribePackagingGroupResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline DescribePackagingGroupResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -156,6 +194,8 @@ namespace Model Aws::String m_domainName; Aws::String m_id; + + Aws::Map m_tags; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceRequest.h new file mode 100644 index 00000000000..699d30e79ab --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceRequest.h @@ -0,0 +1,77 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace MediaPackageVod +{ +namespace Model +{ + + /** + */ + class AWS_MEDIAPACKAGEVOD_API ListTagsForResourceRequest : public MediaPackageVodRequest + { + public: + ListTagsForResourceRequest(); + + // 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 "ListTagsForResource"; } + + Aws::String SerializePayload() const override; + + + + inline const Aws::String& GetResourceArn() const{ return m_resourceArn; } + + + inline bool ResourceArnHasBeenSet() const { return m_resourceArnHasBeenSet; } + + + inline void SetResourceArn(const Aws::String& value) { m_resourceArnHasBeenSet = true; m_resourceArn = value; } + + + inline void SetResourceArn(Aws::String&& value) { m_resourceArnHasBeenSet = true; m_resourceArn = std::move(value); } + + + inline void SetResourceArn(const char* value) { m_resourceArnHasBeenSet = true; m_resourceArn.assign(value); } + + + inline ListTagsForResourceRequest& WithResourceArn(const Aws::String& value) { SetResourceArn(value); return *this;} + + + inline ListTagsForResourceRequest& WithResourceArn(Aws::String&& value) { SetResourceArn(std::move(value)); return *this;} + + + inline ListTagsForResourceRequest& WithResourceArn(const char* value) { SetResourceArn(value); return *this;} + + private: + + Aws::String m_resourceArn; + bool m_resourceArnHasBeenSet; + }; + +} // namespace Model +} // namespace MediaPackageVod +} // namespace Aws diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceResult.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceResult.h new file mode 100644 index 00000000000..e0b3c6c9975 --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/ListTagsForResourceResult.h @@ -0,0 +1,89 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +template +class AmazonWebServiceResult; + +namespace Utils +{ +namespace Json +{ + class JsonValue; +} // namespace Json +} // namespace Utils +namespace MediaPackageVod +{ +namespace Model +{ + class AWS_MEDIAPACKAGEVOD_API ListTagsForResourceResult + { + public: + ListTagsForResourceResult(); + ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result); + ListTagsForResourceResult& operator=(const Aws::AmazonWebServiceResult& result); + + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline void SetTags(const Aws::Map& value) { m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } + + + inline ListTagsForResourceResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline ListTagsForResourceResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline ListTagsForResourceResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } + + + inline ListTagsForResourceResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline ListTagsForResourceResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline ListTagsForResourceResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline ListTagsForResourceResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } + + + inline ListTagsForResourceResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } + + + inline ListTagsForResourceResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } + + private: + + Aws::Map m_tags; + }; + +} // namespace Model +} // namespace MediaPackageVod +} // namespace Aws diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingConfiguration.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingConfiguration.h index f60b4d33882..730fa5fd422 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingConfiguration.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingConfiguration.h @@ -20,6 +20,7 @@ #include #include #include +#include #include namespace Aws @@ -249,6 +250,46 @@ namespace Model */ inline PackagingConfiguration& WithPackagingGroupId(const char* value) { SetPackagingGroupId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline PackagingConfiguration& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline PackagingConfiguration& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline PackagingConfiguration& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline PackagingConfiguration& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline PackagingConfiguration& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline PackagingConfiguration& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline PackagingConfiguration& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline PackagingConfiguration& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline PackagingConfiguration& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -271,6 +312,9 @@ namespace Model Aws::String m_packagingGroupId; bool m_packagingGroupIdHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingGroup.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingGroup.h index 931b65db48e..5f88f4514a9 100644 --- a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingGroup.h +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/PackagingGroup.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include namespace Aws @@ -169,6 +170,46 @@ namespace Model */ inline PackagingGroup& WithId(const char* value) { SetId(value); return *this;} + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline PackagingGroup& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline PackagingGroup& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline PackagingGroup& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline PackagingGroup& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline PackagingGroup& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline PackagingGroup& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline PackagingGroup& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline PackagingGroup& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline PackagingGroup& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + private: Aws::String m_arn; @@ -179,6 +220,9 @@ namespace Model Aws::String m_id; bool m_idHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; }; } // namespace Model diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/TagResourceRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/TagResourceRequest.h new file mode 100644 index 00000000000..daa6c6a1dc0 --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/TagResourceRequest.h @@ -0,0 +1,121 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws +{ +namespace MediaPackageVod +{ +namespace Model +{ + + /** + */ + class AWS_MEDIAPACKAGEVOD_API TagResourceRequest : public MediaPackageVodRequest + { + public: + TagResourceRequest(); + + // 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 "TagResource"; } + + Aws::String SerializePayload() const override; + + + + inline const Aws::String& GetResourceArn() const{ return m_resourceArn; } + + + inline bool ResourceArnHasBeenSet() const { return m_resourceArnHasBeenSet; } + + + inline void SetResourceArn(const Aws::String& value) { m_resourceArnHasBeenSet = true; m_resourceArn = value; } + + + inline void SetResourceArn(Aws::String&& value) { m_resourceArnHasBeenSet = true; m_resourceArn = std::move(value); } + + + inline void SetResourceArn(const char* value) { m_resourceArnHasBeenSet = true; m_resourceArn.assign(value); } + + + inline TagResourceRequest& WithResourceArn(const Aws::String& value) { SetResourceArn(value); return *this;} + + + inline TagResourceRequest& WithResourceArn(Aws::String&& value) { SetResourceArn(std::move(value)); return *this;} + + + inline TagResourceRequest& WithResourceArn(const char* value) { SetResourceArn(value); return *this;} + + + + inline const Aws::Map& GetTags() const{ return m_tags; } + + + inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } + + + inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } + + + inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } + + + inline TagResourceRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} + + + inline TagResourceRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} + + + inline TagResourceRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + + inline TagResourceRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline TagResourceRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline TagResourceRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } + + + inline TagResourceRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } + + + inline TagResourceRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } + + + inline TagResourceRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } + + private: + + Aws::String m_resourceArn; + bool m_resourceArnHasBeenSet; + + Aws::Map m_tags; + bool m_tagsHasBeenSet; + }; + +} // namespace Model +} // namespace MediaPackageVod +} // namespace Aws diff --git a/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/UntagResourceRequest.h b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/UntagResourceRequest.h new file mode 100644 index 00000000000..6575aea4599 --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/include/aws/mediapackage-vod/model/UntagResourceRequest.h @@ -0,0 +1,133 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws +{ +namespace Http +{ + class URI; +} //namespace Http +namespace MediaPackageVod +{ +namespace Model +{ + + /** + */ + class AWS_MEDIAPACKAGEVOD_API UntagResourceRequest : public MediaPackageVodRequest + { + public: + UntagResourceRequest(); + + // 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 "UntagResource"; } + + Aws::String SerializePayload() const override; + + void AddQueryStringParameters(Aws::Http::URI& uri) const override; + + + + inline const Aws::String& GetResourceArn() const{ return m_resourceArn; } + + + inline bool ResourceArnHasBeenSet() const { return m_resourceArnHasBeenSet; } + + + inline void SetResourceArn(const Aws::String& value) { m_resourceArnHasBeenSet = true; m_resourceArn = value; } + + + inline void SetResourceArn(Aws::String&& value) { m_resourceArnHasBeenSet = true; m_resourceArn = std::move(value); } + + + inline void SetResourceArn(const char* value) { m_resourceArnHasBeenSet = true; m_resourceArn.assign(value); } + + + inline UntagResourceRequest& WithResourceArn(const Aws::String& value) { SetResourceArn(value); return *this;} + + + inline UntagResourceRequest& WithResourceArn(Aws::String&& value) { SetResourceArn(std::move(value)); return *this;} + + + inline UntagResourceRequest& WithResourceArn(const char* value) { SetResourceArn(value); return *this;} + + + /** + * The key(s) of tag to be deleted + */ + inline const Aws::Vector& GetTagKeys() const{ return m_tagKeys; } + + /** + * The key(s) of tag to be deleted + */ + inline bool TagKeysHasBeenSet() const { return m_tagKeysHasBeenSet; } + + /** + * The key(s) of tag to be deleted + */ + inline void SetTagKeys(const Aws::Vector& value) { m_tagKeysHasBeenSet = true; m_tagKeys = value; } + + /** + * The key(s) of tag to be deleted + */ + inline void SetTagKeys(Aws::Vector&& value) { m_tagKeysHasBeenSet = true; m_tagKeys = std::move(value); } + + /** + * The key(s) of tag to be deleted + */ + inline UntagResourceRequest& WithTagKeys(const Aws::Vector& value) { SetTagKeys(value); return *this;} + + /** + * The key(s) of tag to be deleted + */ + inline UntagResourceRequest& WithTagKeys(Aws::Vector&& value) { SetTagKeys(std::move(value)); return *this;} + + /** + * The key(s) of tag to be deleted + */ + inline UntagResourceRequest& AddTagKeys(const Aws::String& value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(value); return *this; } + + /** + * The key(s) of tag to be deleted + */ + inline UntagResourceRequest& AddTagKeys(Aws::String&& value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(std::move(value)); return *this; } + + /** + * The key(s) of tag to be deleted + */ + inline UntagResourceRequest& AddTagKeys(const char* value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(value); return *this; } + + private: + + Aws::String m_resourceArn; + bool m_resourceArnHasBeenSet; + + Aws::Vector m_tagKeys; + bool m_tagKeysHasBeenSet; + }; + +} // namespace Model +} // namespace MediaPackageVod +} // namespace Aws diff --git a/aws-cpp-sdk-mediapackage-vod/source/MediaPackageVodClient.cpp b/aws-cpp-sdk-mediapackage-vod/source/MediaPackageVodClient.cpp index 59a81fa8a56..115a9651c94 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/MediaPackageVodClient.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/MediaPackageVodClient.cpp @@ -42,6 +42,9 @@ #include #include #include +#include +#include +#include using namespace Aws; using namespace Aws::Auth; @@ -571,3 +574,131 @@ void MediaPackageVodClient::ListPackagingGroupsAsyncHelper(const ListPackagingGr handler(this, request, ListPackagingGroups(request), context); } +ListTagsForResourceOutcome MediaPackageVodClient::ListTagsForResource(const ListTagsForResourceRequest& request) const +{ + if (!request.ResourceArnHasBeenSet()) + { + AWS_LOGSTREAM_ERROR("ListTagsForResource", "Required field: ResourceArn, is not set"); + return ListTagsForResourceOutcome(Aws::Client::AWSError(MediaPackageVodErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [ResourceArn]", false)); + } + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/tags/"; + ss << request.GetResourceArn(); + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_GET, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return ListTagsForResourceOutcome(ListTagsForResourceResult(outcome.GetResult())); + } + else + { + return ListTagsForResourceOutcome(outcome.GetError()); + } +} + +ListTagsForResourceOutcomeCallable MediaPackageVodClient::ListTagsForResourceCallable(const ListTagsForResourceRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< ListTagsForResourceOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->ListTagsForResource(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void MediaPackageVodClient::ListTagsForResourceAsync(const ListTagsForResourceRequest& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->ListTagsForResourceAsyncHelper( request, handler, context ); } ); +} + +void MediaPackageVodClient::ListTagsForResourceAsyncHelper(const ListTagsForResourceRequest& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, ListTagsForResource(request), context); +} + +TagResourceOutcome MediaPackageVodClient::TagResource(const TagResourceRequest& request) const +{ + if (!request.ResourceArnHasBeenSet()) + { + AWS_LOGSTREAM_ERROR("TagResource", "Required field: ResourceArn, is not set"); + return TagResourceOutcome(Aws::Client::AWSError(MediaPackageVodErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [ResourceArn]", false)); + } + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/tags/"; + ss << request.GetResourceArn(); + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_POST, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return TagResourceOutcome(NoResult()); + } + else + { + return TagResourceOutcome(outcome.GetError()); + } +} + +TagResourceOutcomeCallable MediaPackageVodClient::TagResourceCallable(const TagResourceRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< TagResourceOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->TagResource(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void MediaPackageVodClient::TagResourceAsync(const TagResourceRequest& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->TagResourceAsyncHelper( request, handler, context ); } ); +} + +void MediaPackageVodClient::TagResourceAsyncHelper(const TagResourceRequest& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, TagResource(request), context); +} + +UntagResourceOutcome MediaPackageVodClient::UntagResource(const UntagResourceRequest& request) const +{ + if (!request.ResourceArnHasBeenSet()) + { + AWS_LOGSTREAM_ERROR("UntagResource", "Required field: ResourceArn, is not set"); + return UntagResourceOutcome(Aws::Client::AWSError(MediaPackageVodErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [ResourceArn]", false)); + } + if (!request.TagKeysHasBeenSet()) + { + AWS_LOGSTREAM_ERROR("UntagResource", "Required field: TagKeys, is not set"); + return UntagResourceOutcome(Aws::Client::AWSError(MediaPackageVodErrors::MISSING_PARAMETER, "MISSING_PARAMETER", "Missing required field [TagKeys]", false)); + } + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/tags/"; + ss << request.GetResourceArn(); + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_DELETE, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return UntagResourceOutcome(NoResult()); + } + else + { + return UntagResourceOutcome(outcome.GetError()); + } +} + +UntagResourceOutcomeCallable MediaPackageVodClient::UntagResourceCallable(const UntagResourceRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< UntagResourceOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->UntagResource(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void MediaPackageVodClient::UntagResourceAsync(const UntagResourceRequest& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->UntagResourceAsyncHelper( request, handler, context ); } ); +} + +void MediaPackageVodClient::UntagResourceAsyncHelper(const UntagResourceRequest& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, UntagResource(request), context); +} + diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/AssetShallow.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/AssetShallow.cpp index b69ab278a94..4ea32a75170 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/AssetShallow.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/AssetShallow.cpp @@ -35,7 +35,8 @@ AssetShallow::AssetShallow() : m_packagingGroupIdHasBeenSet(false), m_resourceIdHasBeenSet(false), m_sourceArnHasBeenSet(false), - m_sourceRoleArnHasBeenSet(false) + m_sourceRoleArnHasBeenSet(false), + m_tagsHasBeenSet(false) { } @@ -46,7 +47,8 @@ AssetShallow::AssetShallow(JsonView jsonValue) : m_packagingGroupIdHasBeenSet(false), m_resourceIdHasBeenSet(false), m_sourceArnHasBeenSet(false), - m_sourceRoleArnHasBeenSet(false) + m_sourceRoleArnHasBeenSet(false), + m_tagsHasBeenSet(false) { *this = jsonValue; } @@ -102,6 +104,16 @@ AssetShallow& AssetShallow::operator =(JsonView jsonValue) m_sourceRoleArnHasBeenSet = 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; + } + return *this; } @@ -151,6 +163,17 @@ JsonValue AssetShallow::Jsonize() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload; } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetRequest.cpp index f23da4c3996..5076cf0c8f1 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetRequest.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetRequest.cpp @@ -27,7 +27,8 @@ CreateAssetRequest::CreateAssetRequest() : m_packagingGroupIdHasBeenSet(false), m_resourceIdHasBeenSet(false), m_sourceArnHasBeenSet(false), - m_sourceRoleArnHasBeenSet(false) + m_sourceRoleArnHasBeenSet(false), + m_tagsHasBeenSet(false) { } @@ -65,6 +66,17 @@ Aws::String CreateAssetRequest::SerializePayload() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload.View().WriteReadable(); } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetResult.cpp index aa2d83a9c32..62594477d66 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreateAssetResult.cpp @@ -89,6 +89,15 @@ CreateAssetResult& CreateAssetResult::operator =(const Aws::AmazonWebServiceResu } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationRequest.cpp index 3ff2eaaa3c3..2958694f17e 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationRequest.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationRequest.cpp @@ -28,7 +28,8 @@ CreatePackagingConfigurationRequest::CreatePackagingConfigurationRequest() : m_hlsPackageHasBeenSet(false), m_idHasBeenSet(false), m_mssPackageHasBeenSet(false), - m_packagingGroupIdHasBeenSet(false) + m_packagingGroupIdHasBeenSet(false), + m_tagsHasBeenSet(false) { } @@ -72,6 +73,17 @@ Aws::String CreatePackagingConfigurationRequest::SerializePayload() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload.View().WriteReadable(); } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationResult.cpp index 7573b8cc817..36fc6fdd920 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingConfigurationResult.cpp @@ -80,6 +80,15 @@ CreatePackagingConfigurationResult& CreatePackagingConfigurationResult::operator } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupRequest.cpp index a0e94eb79aa..91f06ffb303 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupRequest.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupRequest.cpp @@ -23,7 +23,8 @@ using namespace Aws::Utils::Json; using namespace Aws::Utils; CreatePackagingGroupRequest::CreatePackagingGroupRequest() : - m_idHasBeenSet(false) + m_idHasBeenSet(false), + m_tagsHasBeenSet(false) { } @@ -37,6 +38,17 @@ Aws::String CreatePackagingGroupRequest::SerializePayload() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload.View().WriteReadable(); } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupResult.cpp index 729af0d28b3..0d5b4013a2e 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/CreatePackagingGroupResult.cpp @@ -56,6 +56,15 @@ CreatePackagingGroupResult& CreatePackagingGroupResult::operator =(const Aws::Am } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/DescribeAssetResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/DescribeAssetResult.cpp index ac42fb0702b..6019907cccc 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/DescribeAssetResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/DescribeAssetResult.cpp @@ -89,6 +89,15 @@ DescribeAssetResult& DescribeAssetResult::operator =(const Aws::AmazonWebService } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingConfigurationResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingConfigurationResult.cpp index c81c6b98d02..e91e164d92d 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingConfigurationResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingConfigurationResult.cpp @@ -80,6 +80,15 @@ DescribePackagingConfigurationResult& DescribePackagingConfigurationResult::oper } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingGroupResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingGroupResult.cpp index 62cd9043571..28cb705bf6a 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingGroupResult.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/DescribePackagingGroupResult.cpp @@ -56,6 +56,15 @@ DescribePackagingGroupResult& DescribePackagingGroupResult::operator =(const Aws } + if(jsonValue.ValueExists("tags")) + { + Aws::Map tagsJsonMap = jsonValue.GetObject("tags").GetAllObjects(); + for(auto& tagsItem : tagsJsonMap) + { + m_tags[tagsItem.first] = tagsItem.second.AsString(); + } + } + return *this; diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceRequest.cpp new file mode 100644 index 00000000000..628265b650f --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceRequest.cpp @@ -0,0 +1,37 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::MediaPackageVod::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +ListTagsForResourceRequest::ListTagsForResourceRequest() : + m_resourceArnHasBeenSet(false) +{ +} + +Aws::String ListTagsForResourceRequest::SerializePayload() const +{ + return {}; +} + + + + diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceResult.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceResult.cpp new file mode 100644 index 00000000000..357a07deec2 --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/source/model/ListTagsForResourceResult.cpp @@ -0,0 +1,53 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#include + +using namespace Aws::MediaPackageVod::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ListTagsForResourceResult::ListTagsForResourceResult() +{ +} + +ListTagsForResourceResult::ListTagsForResourceResult(const Aws::AmazonWebServiceResult& result) +{ + *this = result; +} + +ListTagsForResourceResult& ListTagsForResourceResult::operator =(const Aws::AmazonWebServiceResult& result) +{ + 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(); + } + } + + + + return *this; +} diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/PackagingConfiguration.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/PackagingConfiguration.cpp index bdbb6fb5be9..995fec288e9 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/PackagingConfiguration.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/PackagingConfiguration.cpp @@ -35,7 +35,8 @@ PackagingConfiguration::PackagingConfiguration() : m_hlsPackageHasBeenSet(false), m_idHasBeenSet(false), m_mssPackageHasBeenSet(false), - m_packagingGroupIdHasBeenSet(false) + m_packagingGroupIdHasBeenSet(false), + m_tagsHasBeenSet(false) { } @@ -46,7 +47,8 @@ PackagingConfiguration::PackagingConfiguration(JsonView jsonValue) : m_hlsPackageHasBeenSet(false), m_idHasBeenSet(false), m_mssPackageHasBeenSet(false), - m_packagingGroupIdHasBeenSet(false) + m_packagingGroupIdHasBeenSet(false), + m_tagsHasBeenSet(false) { *this = jsonValue; } @@ -102,6 +104,16 @@ PackagingConfiguration& PackagingConfiguration::operator =(JsonView jsonValue) m_packagingGroupIdHasBeenSet = 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; + } + return *this; } @@ -151,6 +163,17 @@ JsonValue PackagingConfiguration::Jsonize() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload; } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/PackagingGroup.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/PackagingGroup.cpp index b6970adfa88..1db6afc9ad6 100644 --- a/aws-cpp-sdk-mediapackage-vod/source/model/PackagingGroup.cpp +++ b/aws-cpp-sdk-mediapackage-vod/source/model/PackagingGroup.cpp @@ -31,14 +31,16 @@ namespace Model PackagingGroup::PackagingGroup() : m_arnHasBeenSet(false), m_domainNameHasBeenSet(false), - m_idHasBeenSet(false) + m_idHasBeenSet(false), + m_tagsHasBeenSet(false) { } PackagingGroup::PackagingGroup(JsonView jsonValue) : m_arnHasBeenSet(false), m_domainNameHasBeenSet(false), - m_idHasBeenSet(false) + m_idHasBeenSet(false), + m_tagsHasBeenSet(false) { *this = jsonValue; } @@ -66,6 +68,16 @@ PackagingGroup& PackagingGroup::operator =(JsonView jsonValue) m_idHasBeenSet = 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; + } + return *this; } @@ -91,6 +103,17 @@ JsonValue PackagingGroup::Jsonize() const } + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + return payload; } diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/TagResourceRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/TagResourceRequest.cpp new file mode 100644 index 00000000000..74100594b58 --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/source/model/TagResourceRequest.cpp @@ -0,0 +1,51 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::MediaPackageVod::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +TagResourceRequest::TagResourceRequest() : + m_resourceArnHasBeenSet(false), + m_tagsHasBeenSet(false) +{ +} + +Aws::String TagResourceRequest::SerializePayload() const +{ + JsonValue payload; + + if(m_tagsHasBeenSet) + { + JsonValue tagsJsonMap; + for(auto& tagsItem : m_tags) + { + tagsJsonMap.WithString(tagsItem.first, tagsItem.second); + } + payload.WithObject("tags", std::move(tagsJsonMap)); + + } + + return payload.View().WriteReadable(); +} + + + + diff --git a/aws-cpp-sdk-mediapackage-vod/source/model/UntagResourceRequest.cpp b/aws-cpp-sdk-mediapackage-vod/source/model/UntagResourceRequest.cpp new file mode 100644 index 00000000000..58d64e6531e --- /dev/null +++ b/aws-cpp-sdk-mediapackage-vod/source/model/UntagResourceRequest.cpp @@ -0,0 +1,55 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include + +#include + +using namespace Aws::MediaPackageVod::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws::Http; + +UntagResourceRequest::UntagResourceRequest() : + m_resourceArnHasBeenSet(false), + m_tagKeysHasBeenSet(false) +{ +} + +Aws::String UntagResourceRequest::SerializePayload() const +{ + return {}; +} + +void UntagResourceRequest::AddQueryStringParameters(URI& uri) const +{ + Aws::StringStream ss; + if(m_tagKeysHasBeenSet) + { + for(const auto& item : m_tagKeys) + { + ss << item; + uri.AddQueryStringParameter("tagKeys", ss.str()); + ss.str(""); + } + } + +} + + + diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/PinpointClient.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/PinpointClient.h index a7f6328933b..c2c42f8e984 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/PinpointClient.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/PinpointClient.h @@ -3421,8 +3421,9 @@ namespace Model /** *

    Creates a new endpoint for an application or updates the settings and * attributes of an existing endpoint for an application. You can also use this - * operation to define custom attributes (Attributes, Metrics, and UserAttributes - * properties) for an endpoint.

    See Also:

    See Also:

    AWS * API Reference

    */ @@ -3431,8 +3432,9 @@ namespace Model /** *

    Creates a new endpoint for an application or updates the settings and * attributes of an existing endpoint for an application. You can also use this - * operation to define custom attributes (Attributes, Metrics, and UserAttributes - * properties) for an endpoint.

    See Also:

    See Also:

    AWS * API Reference

    * @@ -3443,8 +3445,9 @@ namespace Model /** *

    Creates a new endpoint for an application or updates the settings and * attributes of an existing endpoint for an application. You can also use this - * operation to define custom attributes (Attributes, Metrics, and UserAttributes - * properties) for an endpoint.

    See Also:

    See Also:

    AWS * API Reference

    * @@ -3455,9 +3458,10 @@ namespace Model /** *

    Creates a new batch of endpoints for an application or updates the settings * and attributes of a batch of existing endpoints for an application. You can also - * use this operation to define custom attributes (Attributes, Metrics, and - * UserAttributes properties) for a batch of endpoints.

    See Also:

    - *

    See + * Also:

    AWS * API Reference

    */ @@ -3466,9 +3470,10 @@ namespace Model /** *

    Creates a new batch of endpoints for an application or updates the settings * and attributes of a batch of existing endpoints for an application. You can also - * use this operation to define custom attributes (Attributes, Metrics, and - * UserAttributes properties) for a batch of endpoints.

    See Also:

    - *

    See + * Also:

    AWS * API Reference

    * @@ -3479,9 +3484,10 @@ namespace Model /** *

    Creates a new batch of endpoints for an application or updates the settings * and attributes of a batch of existing endpoints for an application. You can also - * use this operation to define custom attributes (Attributes, Metrics, and - * UserAttributes properties) for a batch of endpoints.

    See Also:

    - *

    See + * Also:

    AWS * API Reference

    * diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationDateRangeKpiResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationDateRangeKpiResponse.h index 617d9fd98b4..21cab4e39e6 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationDateRangeKpiResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationDateRangeKpiResponse.h @@ -135,7 +135,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -146,7 +146,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -157,7 +157,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -168,7 +168,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -179,7 +179,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -190,7 +190,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline ApplicationDateRangeKpiResponse& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -201,7 +201,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline ApplicationDateRangeKpiResponse& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -212,7 +212,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline ApplicationDateRangeKpiResponse& WithKpiName(const char* value) { SetKpiName(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationSettingsResource.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationSettingsResource.h index 7ac5257279c..eff4cc8a343 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationSettingsResource.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ApplicationSettingsResource.h @@ -101,38 +101,44 @@ namespace Model /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline const CampaignHook& GetCampaignHook() const{ return m_campaignHook; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline bool CampaignHookHasBeenSet() const { return m_campaignHookHasBeenSet; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline void SetCampaignHook(const CampaignHook& value) { m_campaignHookHasBeenSet = true; m_campaignHook = value; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline void SetCampaignHook(CampaignHook&& value) { m_campaignHookHasBeenSet = true; m_campaignHook = std::move(value); } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline ApplicationSettingsResource& WithCampaignHook(const CampaignHook& value) { SetCampaignHook(value); return *this;} /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    */ inline ApplicationSettingsResource& WithCampaignHook(CampaignHook&& value) { SetCampaignHook(std::move(value)); return *this;} @@ -187,32 +193,32 @@ namespace Model /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline const CampaignLimits& GetLimits() const{ return m_limits; } /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline bool LimitsHasBeenSet() const { return m_limitsHasBeenSet; } /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline void SetLimits(const CampaignLimits& value) { m_limitsHasBeenSet = true; m_limits = value; } /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline void SetLimits(CampaignLimits&& value) { m_limitsHasBeenSet = true; m_limits = std::move(value); } /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline ApplicationSettingsResource& WithLimits(const CampaignLimits& value) { SetLimits(value); return *this;} /** - *

    The default sending limits for campaigns in the application.

    + *

    The default sending limits for campaigns and journeys in the application.

    */ inline ApplicationSettingsResource& WithLimits(CampaignLimits&& value) { SetLimits(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignCustomMessage.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignCustomMessage.h new file mode 100644 index 00000000000..ec4ff248d80 --- /dev/null +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignCustomMessage.h @@ -0,0 +1,107 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace Pinpoint +{ +namespace Model +{ + + /** + *

    Specifies the contents of a message that's sent through a custom channel to + * recipients of a campaign.

    See Also:

    AWS + * API Reference

    + */ + class AWS_PINPOINT_API CampaignCustomMessage + { + public: + CampaignCustomMessage(); + CampaignCustomMessage(Aws::Utils::Json::JsonView jsonValue); + CampaignCustomMessage& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline const Aws::String& GetData() const{ return m_data; } + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline bool DataHasBeenSet() const { return m_dataHasBeenSet; } + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline void SetData(const Aws::String& value) { m_dataHasBeenSet = true; m_data = value; } + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline void SetData(Aws::String&& value) { m_dataHasBeenSet = true; m_data = std::move(value); } + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline void SetData(const char* value) { m_dataHasBeenSet = true; m_data.assign(value); } + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline CampaignCustomMessage& WithData(const Aws::String& value) { SetData(value); return *this;} + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline CampaignCustomMessage& WithData(Aws::String&& value) { SetData(std::move(value)); return *this;} + + /** + *

    The raw, JSON-formatted string to use as the payload for the message. The + * maximum size is 5 KB.

    + */ + inline CampaignCustomMessage& WithData(const char* value) { SetData(value); return *this;} + + private: + + Aws::String m_data; + bool m_dataHasBeenSet; + }; + +} // namespace Model +} // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignDateRangeKpiResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignDateRangeKpiResponse.h index 70b50885bf5..adba1f389c2 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignDateRangeKpiResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignDateRangeKpiResponse.h @@ -176,7 +176,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -187,7 +187,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -198,7 +198,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -209,7 +209,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -220,7 +220,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -231,7 +231,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline CampaignDateRangeKpiResponse& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -242,7 +242,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline CampaignDateRangeKpiResponse& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -253,7 +253,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline CampaignDateRangeKpiResponse& WithKpiName(const char* value) { SetKpiName(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignHook.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignHook.h index 724dbf4de6b..8bcbcd1e111 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignHook.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignHook.h @@ -35,8 +35,8 @@ namespace Model { /** - *

    Specifies the AWS Lambda function to use as a code hook for a - * campaign.

    See Also:

    Specifies settings for invoking an AWS Lambda function that customizes a + * segment for a campaign.

    See Also:

    AWS * API Reference

    */ @@ -51,80 +51,116 @@ namespace Model /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline const Aws::String& GetLambdaFunctionName() const{ return m_lambdaFunctionName; } /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline bool LambdaFunctionNameHasBeenSet() const { return m_lambdaFunctionNameHasBeenSet; } /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline void SetLambdaFunctionName(const Aws::String& value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName = value; } /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline void SetLambdaFunctionName(Aws::String&& value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName = std::move(value); } /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline void SetLambdaFunctionName(const char* value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName.assign(value); } /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline CampaignHook& WithLambdaFunctionName(const Aws::String& value) { SetLambdaFunctionName(value); return *this;} /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline CampaignHook& WithLambdaFunctionName(Aws::String&& value) { SetLambdaFunctionName(std::move(value)); return *this;} /** *

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon - * Pinpoint invokes to send messages for a campaign.

    + * Pinpoint invokes to customize a segment for a campaign.

    */ inline CampaignHook& WithLambdaFunctionName(const char* value) { SetLambdaFunctionName(value); return *this;} /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline const Mode& GetMode() const{ return m_mode; } /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; } /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline void SetMode(const Mode& value) { m_modeHasBeenSet = true; m_mode = value; } /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline void SetMode(Mode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); } /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline CampaignHook& WithMode(const Mode& value) { SetMode(value); return *this;} /** - *

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    + *

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. + * Possible values are:

    • FILTER - Invoke the function to customize + * the segment that's used by a campaign.

    • DELIVERY - (Deprecated) + * Previously, invoked the function to send a campaign through a custom channel. + * This functionality is not supported anymore. To send a campaign through a custom + * channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects + * of the campaign.

    */ inline CampaignHook& WithMode(Mode&& value) { SetMode(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignLimits.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignLimits.h index 91fb77cf5d9..a97303d3a46 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignLimits.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignLimits.h @@ -32,8 +32,9 @@ namespace Model { /** - *

    Specifies limits on the messages that a campaign can send.

    See - * Also:

    For a campaign, specifies limits on the messages that the campaign can send. + * For an application, specifies the default limits for messages that campaigns and + * journeys in the application can send.

    See Also:

    AWS * API Reference

    */ @@ -48,25 +49,33 @@ namespace Model /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during a 24-hour period. The maximum value is 100.

    + * during a 24-hour period. For an application, this value specifies the default + * limit for the number of messages that campaigns and journeys can send to a + * single endpoint during a 24-hour period. The maximum value is 100.

    */ inline int GetDaily() const{ return m_daily; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during a 24-hour period. The maximum value is 100.

    + * during a 24-hour period. For an application, this value specifies the default + * limit for the number of messages that campaigns and journeys can send to a + * single endpoint during a 24-hour period. The maximum value is 100.

    */ inline bool DailyHasBeenSet() const { return m_dailyHasBeenSet; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during a 24-hour period. The maximum value is 100.

    + * during a 24-hour period. For an application, this value specifies the default + * limit for the number of messages that campaigns and journeys can send to a + * single endpoint during a 24-hour period. The maximum value is 100.

    */ inline void SetDaily(int value) { m_dailyHasBeenSet = true; m_daily = value; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during a 24-hour period. The maximum value is 100.

    + * during a 24-hour period. For an application, this value specifies the default + * limit for the number of messages that campaigns and journeys can send to a + * single endpoint during a 24-hour period. The maximum value is 100.

    */ inline CampaignLimits& WithDaily(int value) { SetDaily(value); return *this;} @@ -101,51 +110,63 @@ namespace Model /** - *

    The maximum number of messages that a campaign can send each second. The - * minimum value is 50. The maximum value is 20,000.

    + *

    The maximum number of messages that a campaign can send each second. For an + * application, this value specifies the default limit for the number of messages + * that campaigns and journeys can send each second. The minimum value is 50. The + * maximum value is 20,000.

    */ inline int GetMessagesPerSecond() const{ return m_messagesPerSecond; } /** - *

    The maximum number of messages that a campaign can send each second. The - * minimum value is 50. The maximum value is 20,000.

    + *

    The maximum number of messages that a campaign can send each second. For an + * application, this value specifies the default limit for the number of messages + * that campaigns and journeys can send each second. The minimum value is 50. The + * maximum value is 20,000.

    */ inline bool MessagesPerSecondHasBeenSet() const { return m_messagesPerSecondHasBeenSet; } /** - *

    The maximum number of messages that a campaign can send each second. The - * minimum value is 50. The maximum value is 20,000.

    + *

    The maximum number of messages that a campaign can send each second. For an + * application, this value specifies the default limit for the number of messages + * that campaigns and journeys can send each second. The minimum value is 50. The + * maximum value is 20,000.

    */ inline void SetMessagesPerSecond(int value) { m_messagesPerSecondHasBeenSet = true; m_messagesPerSecond = value; } /** - *

    The maximum number of messages that a campaign can send each second. The - * minimum value is 50. The maximum value is 20,000.

    + *

    The maximum number of messages that a campaign can send each second. For an + * application, this value specifies the default limit for the number of messages + * that campaigns and journeys can send each second. The minimum value is 50. The + * maximum value is 20,000.

    */ inline CampaignLimits& WithMessagesPerSecond(int value) { SetMessagesPerSecond(value); return *this;} /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during the course of the campaign. The maximum value is 100.

    + * during the course of the campaign. If a campaign recurs, this setting applies to + * all runs of the campaign. The maximum value is 100.

    */ inline int GetTotal() const{ return m_total; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during the course of the campaign. The maximum value is 100.

    + * during the course of the campaign. If a campaign recurs, this setting applies to + * all runs of the campaign. The maximum value is 100.

    */ inline bool TotalHasBeenSet() const { return m_totalHasBeenSet; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during the course of the campaign. The maximum value is 100.

    + * during the course of the campaign. If a campaign recurs, this setting applies to + * all runs of the campaign. The maximum value is 100.

    */ inline void SetTotal(int value) { m_totalHasBeenSet = true; m_total = value; } /** *

    The maximum number of messages that a campaign can send to a single endpoint - * during the course of the campaign. The maximum value is 100.

    + * during the course of the campaign. If a campaign recurs, this setting applies to + * all runs of the campaign. The maximum value is 100.

    */ inline CampaignLimits& WithTotal(int value) { SetTotal(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignResponse.h index 6c609afb5b3..6dcc150e6a3 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignResponse.h @@ -17,6 +17,7 @@ #include #include #include +#include #include #include #include @@ -229,45 +230,76 @@ namespace Model inline CampaignResponse& WithCreationDate(const char* value) { SetCreationDate(value); return *this;} + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline const CustomDeliveryConfiguration& GetCustomDeliveryConfiguration() const{ return m_customDeliveryConfiguration; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline bool CustomDeliveryConfigurationHasBeenSet() const { return m_customDeliveryConfigurationHasBeenSet; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline void SetCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = value; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline void SetCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = std::move(value); } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline CampaignResponse& WithCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { SetCustomDeliveryConfiguration(value); return *this;} + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel.

    + */ + inline CampaignResponse& WithCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { SetCustomDeliveryConfiguration(std::move(value)); return *this;} + + /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline const CampaignState& GetDefaultState() const{ return m_defaultState; } /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline bool DefaultStateHasBeenSet() const { return m_defaultStateHasBeenSet; } /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline void SetDefaultState(const CampaignState& value) { m_defaultStateHasBeenSet = true; m_defaultState = value; } /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline void SetDefaultState(CampaignState&& value) { m_defaultStateHasBeenSet = true; m_defaultState = std::move(value); } /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline CampaignResponse& WithDefaultState(const CampaignState& value) { SetDefaultState(value); return *this;} /** *

    The current status of the campaign's default treatment. This value exists - * only for campaigns that have more than one treatment, to support A/B - * testing.

    + * only for campaigns that have more than one treatment.

    */ inline CampaignResponse& WithDefaultState(CampaignState&& value) { SetDefaultState(std::move(value)); return *this;} @@ -340,36 +372,42 @@ namespace Model /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline const CampaignHook& GetHook() const{ return m_hook; } /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline bool HookHasBeenSet() const { return m_hookHasBeenSet; } /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline void SetHook(const CampaignHook& value) { m_hookHasBeenSet = true; m_hook = value; } /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline void SetHook(CampaignHook&& value) { m_hookHasBeenSet = true; m_hook = std::move(value); } /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline CampaignResponse& WithHook(const CampaignHook& value) { SetHook(value); return *this;} /** *

    The settings for the AWS Lambda function to use as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline CampaignResponse& WithHook(CampaignHook&& value) { SetHook(std::move(value)); return *this;} @@ -841,99 +879,99 @@ namespace Model /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline const Aws::String& GetTreatmentDescription() const{ return m_treatmentDescription; } /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline bool TreatmentDescriptionHasBeenSet() const { return m_treatmentDescriptionHasBeenSet; } /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(const Aws::String& value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription = value; } /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(Aws::String&& value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription = std::move(value); } /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(const char* value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription.assign(value); } /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline CampaignResponse& WithTreatmentDescription(const Aws::String& value) { SetTreatmentDescription(value); return *this;} /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline CampaignResponse& WithTreatmentDescription(Aws::String&& value) { SetTreatmentDescription(std::move(value)); return *this;} /** - *

    The custom description of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom description of the default treatment for the campaign.

    */ inline CampaignResponse& WithTreatmentDescription(const char* value) { SetTreatmentDescription(value); return *this;} /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline const Aws::String& GetTreatmentName() const{ return m_treatmentName; } /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline bool TreatmentNameHasBeenSet() const { return m_treatmentNameHasBeenSet; } /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline void SetTreatmentName(const Aws::String& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = value; } /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline void SetTreatmentName(Aws::String&& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = std::move(value); } /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline void SetTreatmentName(const char* value) { m_treatmentNameHasBeenSet = true; m_treatmentName.assign(value); } /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline CampaignResponse& WithTreatmentName(const Aws::String& value) { SetTreatmentName(value); return *this;} /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline CampaignResponse& WithTreatmentName(Aws::String&& value) { SetTreatmentName(std::move(value)); return *this;} /** - *

    The custom name of a variation of the campaign that's used for A/B - * testing.

    + *

    The custom name of the default treatment for the campaign, if the campaign + * has multiple treatments. A treatment is a variation of a campaign that's + * used for A/B testing.

    */ inline CampaignResponse& WithTreatmentName(const char* value) { SetTreatmentName(value); return *this;} @@ -972,6 +1010,9 @@ namespace Model Aws::String m_creationDate; bool m_creationDateHasBeenSet; + CustomDeliveryConfiguration m_customDeliveryConfiguration; + bool m_customDeliveryConfigurationHasBeenSet; + CampaignState m_defaultState; bool m_defaultStateHasBeenSet; diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignState.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignState.h index 76df7604a49..87639250e7a 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignState.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignState.h @@ -50,49 +50,55 @@ namespace Model /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline const CampaignStatus& GetCampaignStatus() const{ return m_campaignStatus; } /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline bool CampaignStatusHasBeenSet() const { return m_campaignStatusHasBeenSet; } /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline void SetCampaignStatus(const CampaignStatus& value) { m_campaignStatusHasBeenSet = true; m_campaignStatus = value; } /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline void SetCampaignStatus(CampaignStatus&& value) { m_campaignStatusHasBeenSet = true; m_campaignStatus = std::move(value); } /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline CampaignState& WithCampaignStatus(const CampaignStatus& value) { SetCampaignStatus(value); return *this;} /** *

    The current status of the campaign, or the current status of a treatment that - * belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - * has a status of COMPLETED only if all campaign treatments have a status of - * COMPLETED.

    + * belongs to an A/B test campaign.

    If a campaign uses A/B testing, the + * campaign has a status of COMPLETED only if all campaign treatments have a status + * of COMPLETED. If you delete the segment that's associated with a campaign, the + * campaign fails and has a status of DELETED.

    */ inline CampaignState& WithCampaignStatus(CampaignStatus&& value) { SetCampaignStatus(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CreateRecommenderConfiguration.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CreateRecommenderConfiguration.h index 9d52836cd09..f87d9c40edc 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CreateRecommenderConfiguration.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CreateRecommenderConfiguration.h @@ -52,323 +52,344 @@ namespace Model /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline CreateRecommenderConfiguration& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline const Aws::String& GetDescription() const{ return m_description; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline CreateRecommenderConfiguration& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline CreateRecommenderConfiguration& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline CreateRecommenderConfiguration& WithDescription(const char* value) { SetDescription(value); return *this;} @@ -440,7 +461,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -456,7 +477,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -472,7 +493,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -488,7 +509,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -504,7 +525,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -520,7 +541,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -536,7 +557,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -552,7 +573,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -732,150 +753,154 @@ namespace Model /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline const Aws::String& GetRecommendationsDisplayName() const{ return m_recommendationsDisplayName; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline bool RecommendationsDisplayNameHasBeenSet() const { return m_recommendationsDisplayNameHasBeenSet; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(const Aws::String& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = value; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(Aws::String&& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = std::move(value); } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(const char* value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName.assign(value); } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline CreateRecommenderConfiguration& WithRecommendationsDisplayName(const Aws::String& value) { SetRecommendationsDisplayName(value); return *this;} /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline CreateRecommenderConfiguration& WithRecommendationsDisplayName(Aws::String&& value) { SetRecommendationsDisplayName(std::move(value)); return *this;} /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline CreateRecommenderConfiguration& WithRecommendationsDisplayName(const char* value) { SetRecommendationsDisplayName(value); return *this;} /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline int GetRecommendationsPerMessage() const{ return m_recommendationsPerMessage; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline bool RecommendationsPerMessageHasBeenSet() const { return m_recommendationsPerMessageHasBeenSet; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetRecommendationsPerMessage(int value) { m_recommendationsPerMessageHasBeenSet = true; m_recommendationsPerMessage = value; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline CreateRecommenderConfiguration& WithRecommendationsPerMessage(int value) { SetRecommendationsPerMessage(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CustomDeliveryConfiguration.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CustomDeliveryConfiguration.h new file mode 100644 index 00000000000..668f6ba92a2 --- /dev/null +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CustomDeliveryConfiguration.h @@ -0,0 +1,203 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace Pinpoint +{ +namespace Model +{ + + /** + *

    Specifies the delivery configuration settings for sending a campaign or + * campaign treatment through a custom channel. This object is required if you use + * the CampaignCustomMessage object to define the message to send for the campaign + * or campaign treatment.

    See Also:

    AWS + * API Reference

    + */ + class AWS_PINPOINT_API CustomDeliveryConfiguration + { + public: + CustomDeliveryConfiguration(); + CustomDeliveryConfiguration(Aws::Utils::Json::JsonView jsonValue); + CustomDeliveryConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline const Aws::String& GetDeliveryUri() const{ return m_deliveryUri; } + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline bool DeliveryUriHasBeenSet() const { return m_deliveryUriHasBeenSet; } + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline void SetDeliveryUri(const Aws::String& value) { m_deliveryUriHasBeenSet = true; m_deliveryUri = value; } + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline void SetDeliveryUri(Aws::String&& value) { m_deliveryUriHasBeenSet = true; m_deliveryUri = std::move(value); } + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline void SetDeliveryUri(const char* value) { m_deliveryUriHasBeenSet = true; m_deliveryUri.assign(value); } + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline CustomDeliveryConfiguration& WithDeliveryUri(const Aws::String& value) { SetDeliveryUri(value); return *this;} + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline CustomDeliveryConfiguration& WithDeliveryUri(Aws::String&& value) { SetDeliveryUri(std::move(value)); return *this;} + + /** + *

    The destination to send the campaign or treatment to. This value can be one + * of the following:

    • The name or Amazon Resource Name (ARN) of an + * AWS Lambda function to invoke to handle delivery of the campaign or + * treatment.

    • The URL for a web application or service that + * supports HTTPS and can receive the message. The URL has to be a full URL, + * including the HTTPS protocol.

    + */ + inline CustomDeliveryConfiguration& WithDeliveryUri(const char* value) { SetDeliveryUri(value); return *this;} + + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline const Aws::Vector<__EndpointTypesElement>& GetEndpointTypes() const{ return m_endpointTypes; } + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline bool EndpointTypesHasBeenSet() const { return m_endpointTypesHasBeenSet; } + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline void SetEndpointTypes(const Aws::Vector<__EndpointTypesElement>& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes = value; } + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline void SetEndpointTypes(Aws::Vector<__EndpointTypesElement>&& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes = std::move(value); } + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline CustomDeliveryConfiguration& WithEndpointTypes(const Aws::Vector<__EndpointTypesElement>& value) { SetEndpointTypes(value); return *this;} + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline CustomDeliveryConfiguration& WithEndpointTypes(Aws::Vector<__EndpointTypesElement>&& value) { SetEndpointTypes(std::move(value)); return *this;} + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline CustomDeliveryConfiguration& AddEndpointTypes(const __EndpointTypesElement& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes.push_back(value); return *this; } + + /** + *

    The types of endpoints to send the campaign or treatment to. Each valid value + * maps to a type of channel that you can associate with an endpoint by using the + * ChannelType property of an endpoint.

    + */ + inline CustomDeliveryConfiguration& AddEndpointTypes(__EndpointTypesElement&& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes.push_back(std::move(value)); return *this; } + + private: + + Aws::String m_deliveryUri; + bool m_deliveryUriHasBeenSet; + + Aws::Vector<__EndpointTypesElement> m_endpointTypes; + bool m_endpointTypesHasBeenSet; + }; + +} // namespace Model +} // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelRequest.h index a8581672f46..0ab836da1f1 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelRequest.h @@ -49,58 +49,66 @@ namespace Model /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline const Aws::String& GetConfigurationSet() const{ return m_configurationSet; } /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline bool ConfigurationSetHasBeenSet() const { return m_configurationSetHasBeenSet; } /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline void SetConfigurationSet(const Aws::String& value) { m_configurationSetHasBeenSet = true; m_configurationSet = value; } /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline void SetConfigurationSet(Aws::String&& value) { m_configurationSetHasBeenSet = true; m_configurationSet = std::move(value); } /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline void SetConfigurationSet(const char* value) { m_configurationSetHasBeenSet = true; m_configurationSet.assign(value); } /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline EmailChannelRequest& WithConfigurationSet(const Aws::String& value) { SetConfigurationSet(value); return *this;} /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline EmailChannelRequest& WithConfigurationSet(Aws::String&& value) { SetConfigurationSet(std::move(value)); return *this;} /** - *

    The configuration set that you want to apply to email that you send through - * the channel by using the Amazon Pinpoint Email - * API.

    + *

    The Amazon + * SES configuration set that you want to apply to messages that you send + * through the channel.

    */ inline EmailChannelRequest& WithConfigurationSet(const char* value) { SetConfigurationSet(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelResponse.h index 20b097be8e5..55d6ef0becb 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EmailChannelResponse.h @@ -98,50 +98,66 @@ namespace Model /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline const Aws::String& GetConfigurationSet() const{ return m_configurationSet; } /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline bool ConfigurationSetHasBeenSet() const { return m_configurationSetHasBeenSet; } /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline void SetConfigurationSet(const Aws::String& value) { m_configurationSetHasBeenSet = true; m_configurationSet = value; } /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline void SetConfigurationSet(Aws::String&& value) { m_configurationSetHasBeenSet = true; m_configurationSet = std::move(value); } /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline void SetConfigurationSet(const char* value) { m_configurationSetHasBeenSet = true; m_configurationSet.assign(value); } /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline EmailChannelResponse& WithConfigurationSet(const Aws::String& value) { SetConfigurationSet(value); return *this;} /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline EmailChannelResponse& WithConfigurationSet(Aws::String&& value) { SetConfigurationSet(std::move(value)); return *this;} /** - *

    The configuration set that's applied to email that's sent through the channel - * by using the Amazon Pinpoint Email API.

    + *

    The Amazon + * SES configuration set that's applied to messages that are sent through the + * channel.

    */ inline EmailChannelResponse& WithConfigurationSet(const char* value) { SetConfigurationSet(value); return *this;} @@ -217,49 +233,49 @@ namespace Model /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline const Aws::String& GetFromAddress() const{ return m_fromAddress; } /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline bool FromAddressHasBeenSet() const { return m_fromAddressHasBeenSet; } /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline void SetFromAddress(const Aws::String& value) { m_fromAddressHasBeenSet = true; m_fromAddress = value; } /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline void SetFromAddress(Aws::String&& value) { m_fromAddressHasBeenSet = true; m_fromAddress = std::move(value); } /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline void SetFromAddress(const char* value) { m_fromAddressHasBeenSet = true; m_fromAddress.assign(value); } /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline EmailChannelResponse& WithFromAddress(const Aws::String& value) { SetFromAddress(value); return *this;} /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline EmailChannelResponse& WithFromAddress(Aws::String&& value) { SetFromAddress(std::move(value)); return *this;} /** - *

    The verified email address that you send email from when you send email + *

    The verified email address that email is sent from when you send email * through the channel.

    */ inline EmailChannelResponse& WithFromAddress(const char* value) { SetFromAddress(value); return *this;} @@ -337,56 +353,56 @@ namespace Model /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline const Aws::String& GetIdentity() const{ return m_identity; } /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline bool IdentityHasBeenSet() const { return m_identityHasBeenSet; } /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline void SetIdentity(const Aws::String& value) { m_identityHasBeenSet = true; m_identity = value; } /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline void SetIdentity(Aws::String&& value) { m_identityHasBeenSet = true; m_identity = std::move(value); } /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline void SetIdentity(const char* value) { m_identityHasBeenSet = true; m_identity.assign(value); } /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline EmailChannelResponse& WithIdentity(const Aws::String& value) { SetIdentity(value); return *this;} /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline EmailChannelResponse& WithIdentity(Aws::String&& value) { SetIdentity(std::move(value)); return *this;} /** *

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple - * Email Service (Amazon SES), that you use when you send email through the + * Email Service (Amazon SES), that's used when you send email through the * channel.

    */ inline EmailChannelResponse& WithIdentity(const char* value) { SetIdentity(value); return *this;} @@ -504,25 +520,25 @@ namespace Model /** - *

    The maximum number of emails that you can send through the channel each + *

    The maximum number of emails that can be sent through the channel each * second.

    */ inline int GetMessagesPerSecond() const{ return m_messagesPerSecond; } /** - *

    The maximum number of emails that you can send through the channel each + *

    The maximum number of emails that can be sent through the channel each * second.

    */ inline bool MessagesPerSecondHasBeenSet() const { return m_messagesPerSecondHasBeenSet; } /** - *

    The maximum number of emails that you can send through the channel each + *

    The maximum number of emails that can be sent through the channel each * second.

    */ inline void SetMessagesPerSecond(int value) { m_messagesPerSecondHasBeenSet = true; m_messagesPerSecond = value; } /** - *

    The maximum number of emails that you can send through the channel each + *

    The maximum number of emails that can be sent through the channel each * second.

    */ inline EmailChannelResponse& WithMessagesPerSecond(int value) { SetMessagesPerSecond(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointBatchItem.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointBatchItem.h index ec0ec6d5bbf..6a0f0b7bc34 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointBatchItem.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointBatchItem.h @@ -750,38 +750,38 @@ namespace Model /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline const EndpointUser& GetUser() const{ return m_user; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline void SetUser(const EndpointUser& value) { m_userHasBeenSet = true; m_user = value; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline void SetUser(EndpointUser&& value) { m_userHasBeenSet = true; m_user = std::move(value); } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline EndpointBatchItem& WithUser(const EndpointUser& value) { SetUser(value); return *this;} /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline EndpointBatchItem& WithUser(EndpointUser&& value) { SetUser(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointRequest.h index 3dda93a34f6..14a1269b7a2 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/EndpointRequest.h @@ -701,38 +701,38 @@ namespace Model /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline const EndpointUser& GetUser() const{ return m_user; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline void SetUser(const EndpointUser& value) { m_userHasBeenSet = true; m_user = value; } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline void SetUser(EndpointUser&& value) { m_userHasBeenSet = true; m_user = std::move(value); } /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline EndpointRequest& WithUser(const EndpointUser& value) { SetUser(value); return *this;} /** - *

    One or more custom user attributes that describe the user who's associated - * with the endpoint.

    + *

    One or more custom attributes that describe the user who's associated with + * the endpoint.

    */ inline EndpointRequest& WithUser(EndpointUser&& value) { SetUser(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetApplicationDateRangeKpiRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetApplicationDateRangeKpiRequest.h index cc110fbdb16..39ab6b14c68 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetApplicationDateRangeKpiRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetApplicationDateRangeKpiRequest.h @@ -153,7 +153,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -164,7 +164,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -175,7 +175,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -186,7 +186,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -197,7 +197,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -208,7 +208,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetApplicationDateRangeKpiRequest& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -219,7 +219,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetApplicationDateRangeKpiRequest& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -230,7 +230,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetApplicationDateRangeKpiRequest& WithKpiName(const char* value) { SetKpiName(value); return *this;} @@ -238,113 +238,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetApplicationDateRangeKpiRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetAppsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetAppsRequest.h index 579bc8372ad..2bcd3089f8b 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetAppsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetAppsRequest.h @@ -50,56 +50,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetAppsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetAppsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetAppsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignActivitiesRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignActivitiesRequest.h index 69620eae96d..433fd69db32 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignActivitiesRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignActivitiesRequest.h @@ -140,56 +140,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignActivitiesRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignActivitiesRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignActivitiesRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignDateRangeKpiRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignDateRangeKpiRequest.h index 3964edf67e7..78e5155fa4e 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignDateRangeKpiRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignDateRangeKpiRequest.h @@ -194,7 +194,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -205,7 +205,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -216,7 +216,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -227,7 +227,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -238,7 +238,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -249,7 +249,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetCampaignDateRangeKpiRequest& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -260,7 +260,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetCampaignDateRangeKpiRequest& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -271,7 +271,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetCampaignDateRangeKpiRequest& WithKpiName(const char* value) { SetKpiName(value); return *this;} @@ -279,113 +279,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignDateRangeKpiRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignVersionsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignVersionsRequest.h index 49753f1db88..5bbfdc7b0d3 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignVersionsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignVersionsRequest.h @@ -140,56 +140,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignVersionsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignVersionsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignVersionsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignsRequest.h index d1c28980ddf..d0de6023ea4 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetCampaignsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetCampaignsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetExportJobsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetExportJobsRequest.h index 754e0bc037d..ea540bfa539 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetExportJobsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetExportJobsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetExportJobsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetExportJobsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetExportJobsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetImportJobsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetImportJobsRequest.h index c0b577b0aa5..b5a72ce860d 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetImportJobsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetImportJobsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetImportJobsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetImportJobsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetImportJobsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyDateRangeKpiRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyDateRangeKpiRequest.h index 4ead7f9b5c9..24c80b01c36 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyDateRangeKpiRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyDateRangeKpiRequest.h @@ -194,7 +194,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -205,7 +205,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -216,7 +216,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -227,7 +227,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -238,7 +238,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -249,7 +249,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetJourneyDateRangeKpiRequest& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -260,7 +260,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetJourneyDateRangeKpiRequest& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -271,7 +271,7 @@ namespace Model * consists of two or more terms, which are comprised of lowercase alphanumeric * characters, separated by a hyphen. Examples are email-open-rate and * successful-delivery-rate. For a list of valid values, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline GetJourneyDateRangeKpiRequest& WithKpiName(const char* value) { SetKpiName(value); return *this;} @@ -279,113 +279,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyDateRangeKpiRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionActivityMetricsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionActivityMetricsRequest.h index d33bae3dfaf..b6c07ef2731 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionActivityMetricsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionActivityMetricsRequest.h @@ -181,113 +181,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionMetricsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionMetricsRequest.h index f9d62b75cac..d1719fcde33 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionMetricsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetJourneyExecutionMetricsRequest.h @@ -140,113 +140,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetJourneyExecutionMetricsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetRecommenderConfigurationsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetRecommenderConfigurationsRequest.h index 81944a61199..78719de259e 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetRecommenderConfigurationsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetRecommenderConfigurationsRequest.h @@ -50,56 +50,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetRecommenderConfigurationsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetRecommenderConfigurationsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetRecommenderConfigurationsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentExportJobsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentExportJobsRequest.h index a3bbb86ef9d..c7d340f0355 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentExportJobsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentExportJobsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentExportJobsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentExportJobsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentExportJobsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentImportJobsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentImportJobsRequest.h index f5d4460904f..18bec33e40c 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentImportJobsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentImportJobsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentImportJobsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentImportJobsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentImportJobsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentVersionsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentVersionsRequest.h index 92abb4433eb..6f104fc8e34 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentVersionsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentVersionsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentVersionsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentVersionsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentVersionsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentsRequest.h index 3a6263bc563..0dc878f0011 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/GetSegmentsRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline GetSegmentsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyDateRangeKpiResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyDateRangeKpiResponse.h index 624c04b4174..da26e5e205d 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyDateRangeKpiResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyDateRangeKpiResponse.h @@ -176,7 +176,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::String& GetKpiName() const{ return m_kpiName; } @@ -187,7 +187,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool KpiNameHasBeenSet() const { return m_kpiNameHasBeenSet; } @@ -198,7 +198,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const Aws::String& value) { m_kpiNameHasBeenSet = true; m_kpiName = value; } @@ -209,7 +209,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(Aws::String&& value) { m_kpiNameHasBeenSet = true; m_kpiName = std::move(value); } @@ -220,7 +220,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetKpiName(const char* value) { m_kpiNameHasBeenSet = true; m_kpiName.assign(value); } @@ -231,7 +231,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyDateRangeKpiResponse& WithKpiName(const Aws::String& value) { SetKpiName(value); return *this;} @@ -242,7 +242,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyDateRangeKpiResponse& WithKpiName(Aws::String&& value) { SetKpiName(std::move(value)); return *this;} @@ -253,7 +253,7 @@ namespace Model * metric and consists of two or more terms, which are comprised of lowercase * alphanumeric characters, separated by a hyphen. For a list of possible values, * see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyDateRangeKpiResponse& WithKpiName(const char* value) { SetKpiName(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionActivityMetricsResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionActivityMetricsResponse.h index e3d2ca0445d..6b348afc3d9 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionActivityMetricsResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionActivityMetricsResponse.h @@ -371,7 +371,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::Map& GetMetrics() const{ return m_metrics; } @@ -380,7 +380,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool MetricsHasBeenSet() const { return m_metricsHasBeenSet; } @@ -389,7 +389,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetMetrics(const Aws::Map& value) { m_metricsHasBeenSet = true; m_metrics = value; } @@ -398,7 +398,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetMetrics(Aws::Map&& value) { m_metricsHasBeenSet = true; m_metrics = std::move(value); } @@ -407,7 +407,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& WithMetrics(const Aws::Map& value) { SetMetrics(value); return *this;} @@ -416,7 +416,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& WithMetrics(Aws::Map&& value) { SetMetrics(std::move(value)); return *this;} @@ -425,7 +425,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } @@ -434,7 +434,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } @@ -443,7 +443,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(const Aws::String& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } @@ -452,7 +452,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), std::move(value)); return *this; } @@ -461,7 +461,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(const char* key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } @@ -470,7 +470,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(Aws::String&& key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } @@ -479,7 +479,7 @@ namespace Model *

    A JSON object that contains the results of the query. The results vary * depending on the type of activity (ActivityType). For information about the * structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionActivityMetricsResponse& AddMetrics(const char* key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionMetricsResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionMetricsResponse.h index 1d7a4b6998d..acb8c1bdd43 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionMetricsResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/JourneyExecutionMetricsResponse.h @@ -184,7 +184,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline const Aws::Map& GetMetrics() const{ return m_metrics; } @@ -192,7 +192,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline bool MetricsHasBeenSet() const { return m_metricsHasBeenSet; } @@ -200,7 +200,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetMetrics(const Aws::Map& value) { m_metricsHasBeenSet = true; m_metrics = value; } @@ -208,7 +208,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline void SetMetrics(Aws::Map&& value) { m_metricsHasBeenSet = true; m_metrics = std::move(value); } @@ -216,7 +216,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& WithMetrics(const Aws::Map& value) { SetMetrics(value); return *this;} @@ -224,7 +224,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& WithMetrics(Aws::Map&& value) { SetMetrics(std::move(value)); return *this;} @@ -232,7 +232,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(const Aws::String& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } @@ -240,7 +240,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(Aws::String&& key, const Aws::String& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } @@ -248,7 +248,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(const Aws::String& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } @@ -256,7 +256,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(Aws::String&& key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), std::move(value)); return *this; } @@ -264,7 +264,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(const char* key, Aws::String&& value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, std::move(value)); return *this; } @@ -272,7 +272,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(Aws::String&& key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } @@ -280,7 +280,7 @@ namespace Model /** *

    A JSON object that contains the results of the query. For information about * the structure and contents of the results, see the Amazon + * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon * Pinpoint Developer Guide.

    */ inline JourneyExecutionMetricsResponse& AddMetrics(const char* key, const char* value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListJourneysRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListJourneysRequest.h index e968d44f2a6..14a8358a3c2 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListJourneysRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListJourneysRequest.h @@ -99,56 +99,56 @@ namespace Model /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListJourneysRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListJourneysRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListJourneysRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplateVersionsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplateVersionsRequest.h index e036e051d41..5bb97b447a7 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplateVersionsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplateVersionsRequest.h @@ -50,113 +50,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplateVersionsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplateVersionsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplateVersionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplateVersionsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplateVersionsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplateVersionsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplatesRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplatesRequest.h index 6db4825f44c..9f54d2d51a4 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplatesRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/ListTemplatesRequest.h @@ -50,113 +50,113 @@ namespace Model /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplatesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplatesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

    The string that specifies which page of results to return in a paginated - * response. This parameter is currently not supported for application, campaign, - * and journey metrics.

    + * response. This parameter is not supported for application, campaign, and journey + * metrics.

    */ inline ListTemplatesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline const Aws::String& GetPageSize() const{ return m_pageSize; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); } /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplatesRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplatesRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;} /** *

    The maximum number of items to include in each page of a paginated response. - * This parameter is currently not supported for application, campaign, and journey + * This parameter is not supported for application, campaign, and journey * metrics.

    */ inline ListTemplatesRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/MessageConfiguration.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/MessageConfiguration.h index 207bd902589..25eae80b0d7 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/MessageConfiguration.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/MessageConfiguration.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include #include #include @@ -52,115 +53,158 @@ namespace Model /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline const Message& GetADMMessage() const{ return m_aDMMessage; } /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline bool ADMMessageHasBeenSet() const { return m_aDMMessageHasBeenSet; } /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline void SetADMMessage(const Message& value) { m_aDMMessageHasBeenSet = true; m_aDMMessage = value; } /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline void SetADMMessage(Message&& value) { m_aDMMessageHasBeenSet = true; m_aDMMessage = std::move(value); } /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithADMMessage(const Message& value) { SetADMMessage(value); return *this;} /** *

    The message that the campaign sends through the ADM (Amazon Device Messaging) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithADMMessage(Message&& value) { SetADMMessage(std::move(value)); return *this;} /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline const Message& GetAPNSMessage() const{ return m_aPNSMessage; } /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline bool APNSMessageHasBeenSet() const { return m_aPNSMessageHasBeenSet; } /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline void SetAPNSMessage(const Message& value) { m_aPNSMessageHasBeenSet = true; m_aPNSMessage = value; } /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline void SetAPNSMessage(Message&& value) { m_aPNSMessageHasBeenSet = true; m_aPNSMessage = std::move(value); } /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithAPNSMessage(const Message& value) { SetAPNSMessage(value); return *this;} /** *

    The message that the campaign sends through the APNs (Apple Push Notification - * service) channel. This message overrides the default message.

    + * service) channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithAPNSMessage(Message&& value) { SetAPNSMessage(std::move(value)); return *this;} /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline const Message& GetBaiduMessage() const{ return m_baiduMessage; } /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline bool BaiduMessageHasBeenSet() const { return m_baiduMessageHasBeenSet; } /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline void SetBaiduMessage(const Message& value) { m_baiduMessageHasBeenSet = true; m_baiduMessage = value; } /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline void SetBaiduMessage(Message&& value) { m_baiduMessageHasBeenSet = true; m_baiduMessage = std::move(value); } /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithBaiduMessage(const Message& value) { SetBaiduMessage(value); return *this;} /** *

    The message that the campaign sends through the Baidu (Baidu Cloud Push) - * channel. This message overrides the default message.

    + * channel. If specified, this message overrides the default message.

    */ inline MessageConfiguration& WithBaiduMessage(Message&& value) { SetBaiduMessage(std::move(value)); return *this;} + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline const CampaignCustomMessage& GetCustomMessage() const{ return m_customMessage; } + + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline bool CustomMessageHasBeenSet() const { return m_customMessageHasBeenSet; } + + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline void SetCustomMessage(const CampaignCustomMessage& value) { m_customMessageHasBeenSet = true; m_customMessage = value; } + + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline void SetCustomMessage(CampaignCustomMessage&& value) { m_customMessageHasBeenSet = true; m_customMessage = std::move(value); } + + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline MessageConfiguration& WithCustomMessage(const CampaignCustomMessage& value) { SetCustomMessage(value); return *this;} + + /** + *

    The message that the campaign sends through a custom channel, as specified by + * the delivery configuration (CustomDeliveryConfiguration) settings for the + * campaign. If specified, this message overrides the default message.

    + */ + inline MessageConfiguration& WithCustomMessage(CampaignCustomMessage&& value) { SetCustomMessage(std::move(value)); return *this;} + + /** *

    The default message that the campaign sends through all the channels that are * configured for the campaign.

    @@ -199,32 +243,38 @@ namespace Model /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline const CampaignEmailMessage& GetEmailMessage() const{ return m_emailMessage; } /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline bool EmailMessageHasBeenSet() const { return m_emailMessageHasBeenSet; } /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline void SetEmailMessage(const CampaignEmailMessage& value) { m_emailMessageHasBeenSet = true; m_emailMessage = value; } /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline void SetEmailMessage(CampaignEmailMessage&& value) { m_emailMessageHasBeenSet = true; m_emailMessage = std::move(value); } /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline MessageConfiguration& WithEmailMessage(const CampaignEmailMessage& value) { SetEmailMessage(value); return *this;} /** - *

    The message that the campaign sends through the email channel.

    + *

    The message that the campaign sends through the email channel. If specified, + * this message overrides the default message.

    */ inline MessageConfiguration& WithEmailMessage(CampaignEmailMessage&& value) { SetEmailMessage(std::move(value)); return *this;} @@ -232,79 +282,85 @@ namespace Model /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline const Message& GetGCMMessage() const{ return m_gCMMessage; } /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline bool GCMMessageHasBeenSet() const { return m_gCMMessageHasBeenSet; } /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline void SetGCMMessage(const Message& value) { m_gCMMessageHasBeenSet = true; m_gCMMessage = value; } /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline void SetGCMMessage(Message&& value) { m_gCMMessageHasBeenSet = true; m_gCMMessage = std::move(value); } /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline MessageConfiguration& WithGCMMessage(const Message& value) { SetGCMMessage(value); return *this;} /** *

    The message that the campaign sends through the GCM channel, which enables * Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging - * (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides - * the default message.

    + * (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this + * message overrides the default message.

    */ inline MessageConfiguration& WithGCMMessage(Message&& value) { SetGCMMessage(std::move(value)); return *this;} /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline const CampaignSmsMessage& GetSMSMessage() const{ return m_sMSMessage; } /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline bool SMSMessageHasBeenSet() const { return m_sMSMessageHasBeenSet; } /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline void SetSMSMessage(const CampaignSmsMessage& value) { m_sMSMessageHasBeenSet = true; m_sMSMessage = value; } /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline void SetSMSMessage(CampaignSmsMessage&& value) { m_sMSMessageHasBeenSet = true; m_sMSMessage = std::move(value); } /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline MessageConfiguration& WithSMSMessage(const CampaignSmsMessage& value) { SetSMSMessage(value); return *this;} /** - *

    The message that the campaign sends through the SMS channel.

    + *

    The message that the campaign sends through the SMS channel. If specified, + * this message overrides the default message.

    */ inline MessageConfiguration& WithSMSMessage(CampaignSmsMessage&& value) { SetSMSMessage(std::move(value)); return *this;} @@ -319,6 +375,9 @@ namespace Model Message m_baiduMessage; bool m_baiduMessageHasBeenSet; + CampaignCustomMessage m_customMessage; + bool m_customMessageHasBeenSet; + Message m_defaultMessage; bool m_defaultMessageHasBeenSet; diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/RecommenderConfigurationResponse.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/RecommenderConfigurationResponse.h index 08ba3bb402d..69b21eb13ef 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/RecommenderConfigurationResponse.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/RecommenderConfigurationResponse.h @@ -52,144 +52,157 @@ namespace Model /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map that defines 1-10 custom endpoint or user attributes, depending on the - * value for the RecommenderUserIdType property. Each of these attributes + * value for the RecommendationProviderIdType property. Each of these attributes * temporarily stores a recommended item that's retrieved from the recommender * model and sent to an AWS Lambda function for additional processing. Each * attribute can be used as a message variable in a message template.

    This * value is null if the configuration doesn't invoke an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } @@ -717,122 +730,130 @@ namespace Model /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline const Aws::String& GetRecommendationsDisplayName() const{ return m_recommendationsDisplayName; } /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline bool RecommendationsDisplayNameHasBeenSet() const { return m_recommendationsDisplayNameHasBeenSet; } /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetRecommendationsDisplayName(const Aws::String& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = value; } /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetRecommendationsDisplayName(Aws::String&& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = std::move(value); } /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetRecommendationsDisplayName(const char* value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName.assign(value); } /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& WithRecommendationsDisplayName(const Aws::String& value) { SetRecommendationsDisplayName(value); return *this;} /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& WithRecommendationsDisplayName(Aws::String&& value) { SetRecommendationsDisplayName(std::move(value)); return *this;} /** *

    The custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This name appears in the Attribute finder pane of the template editor on - * the Amazon Pinpoint console.

    This value is null if the configuration - * doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional - * processing of recommendation data.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This name appears in the Attribute finder of the template + * editor on the Amazon Pinpoint console.

    This value is null if the + * configuration doesn't invoke an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline RecommenderConfigurationResponse& WithRecommendationsDisplayName(const char* value) { SetRecommendationsDisplayName(value); return *this;} /** *

    The number of recommended items that are retrieved from the model for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This number determines how many recommended attributes are available for use as - * message variables in message templates.

    + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This number determines how many recommended items are available for + * use in message variables.

    */ inline int GetRecommendationsPerMessage() const{ return m_recommendationsPerMessage; } /** *

    The number of recommended items that are retrieved from the model for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This number determines how many recommended attributes are available for use as - * message variables in message templates.

    + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This number determines how many recommended items are available for + * use in message variables.

    */ inline bool RecommendationsPerMessageHasBeenSet() const { return m_recommendationsPerMessageHasBeenSet; } /** *

    The number of recommended items that are retrieved from the model for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This number determines how many recommended attributes are available for use as - * message variables in message templates.

    + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This number determines how many recommended items are available for + * use in message variables.

    */ inline void SetRecommendationsPerMessage(int value) { m_recommendationsPerMessageHasBeenSet = true; m_recommendationsPerMessage = value; } /** *

    The number of recommended items that are retrieved from the model for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This number determines how many recommended attributes are available for use as - * message variables in message templates.

    + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This number determines how many recommended items are available for + * use in message variables.

    */ inline RecommenderConfigurationResponse& WithRecommendationsPerMessage(int value) { SetRecommendationsPerMessage(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/TreatmentResource.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/TreatmentResource.h index 2916eac0ad6..28387ee32cf 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/TreatmentResource.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/TreatmentResource.h @@ -15,6 +15,7 @@ #pragma once #include +#include #include #include #include @@ -38,8 +39,8 @@ namespace Model { /** - *

    Specifies the settings for a campaign treatment. A treatment is a variation - * of a campaign that's used for A/B testing of a campaign.

    See + *

    Specifies the settings for a campaign treatment. A treatment is a + * variation of a campaign that's used for A/B testing of a campaign.

    See * Also:

    AWS * API Reference

    @@ -53,6 +54,49 @@ namespace Model Aws::Utils::Json::JsonValue Jsonize() const; + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline const CustomDeliveryConfiguration& GetCustomDeliveryConfiguration() const{ return m_customDeliveryConfiguration; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline bool CustomDeliveryConfigurationHasBeenSet() const { return m_customDeliveryConfigurationHasBeenSet; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = value; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = std::move(value); } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline TreatmentResource& WithCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { SetCustomDeliveryConfiguration(value); return *this;} + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline TreatmentResource& WithCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { SetCustomDeliveryConfiguration(std::move(value)); return *this;} + + /** *

    The unique identifier for the treatment.

    */ @@ -285,55 +329,50 @@ namespace Model /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline const Aws::String& GetTreatmentName() const{ return m_treatmentName; } /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline bool TreatmentNameHasBeenSet() const { return m_treatmentNameHasBeenSet; } /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline void SetTreatmentName(const Aws::String& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = value; } /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline void SetTreatmentName(Aws::String&& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = std::move(value); } /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline void SetTreatmentName(const char* value) { m_treatmentNameHasBeenSet = true; m_treatmentName.assign(value); } /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline TreatmentResource& WithTreatmentName(const Aws::String& value) { SetTreatmentName(value); return *this;} /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline TreatmentResource& WithTreatmentName(Aws::String&& value) { SetTreatmentName(std::move(value)); return *this;} /** - *

    The custom name of the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    The custom name of the treatment.

    */ inline TreatmentResource& WithTreatmentName(const char* value) { SetTreatmentName(value); return *this;} private: + CustomDeliveryConfiguration m_customDeliveryConfiguration; + bool m_customDeliveryConfigurationHasBeenSet; + Aws::String m_id; bool m_idHasBeenSet; diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/UpdateRecommenderConfiguration.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/UpdateRecommenderConfiguration.h index b6cbdf19dac..6b623f2058e 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/UpdateRecommenderConfiguration.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/UpdateRecommenderConfiguration.h @@ -52,323 +52,344 @@ namespace Model /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

    A map of key-value pairs that defines 1-10 custom endpoint or user - * attributes, depending on the value for the RecommenderUserIdType property. Each - * of these attributes temporarily stores a recommended item that's retrieved from - * the recommender model and sent to an AWS Lambda function for additional - * processing. Each attribute can be used as a message variable in a message - * template.

    In the map, the key is the name of a custom attribute and the - * value is a custom display name for that attribute. The display name appears in - * the Attribute finder pane of the template editor on the Amazon Pinpoint - * console. The following restrictions apply to these names:

    • An - * attribute name must start with a letter or number and it can contain up to 50 - * characters. The characters can be letters, numbers, underscores (_), or hyphens - * (-). Attribute names are case sensitive and must be unique.

    • An - * attribute display name must start with a letter or number and it can contain up - * to 25 characters. The characters can be letters, numbers, spaces, underscores - * (_), or hyphens (-).

    This object is required if the - * configuration invokes an AWS Lambda function (LambdaFunctionArn) to process - * recommendation data. Otherwise, don't include this object in your request.

    + * attributes, depending on the value for the RecommendationProviderIdType + * property. Each of these attributes temporarily stores a recommended item that's + * retrieved from the recommender model and sent to an AWS Lambda function for + * additional processing. Each attribute can be used as a message variable in a + * message template.

    In the map, the key is the name of a custom attribute + * and the value is a custom display name for that attribute. The display name + * appears in the Attribute finder of the template editor on the Amazon + * Pinpoint console. The following restrictions apply to these names:

    + *

    • An attribute name must start with a letter or number and it can + * contain up to 50 characters. The characters can be letters, numbers, underscores + * (_), or hyphens (-). Attribute names are case sensitive and must be + * unique.

    • An attribute display name must start with a letter or + * number and it can contain up to 25 characters. The characters can be letters, + * numbers, spaces, underscores (_), or hyphens (-).

    This object + * is required if the configuration invokes an AWS Lambda function + * (RecommendationTransformerUri) to process recommendation data. Otherwise, don't + * include this object in your request.

    */ inline UpdateRecommenderConfiguration& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline const Aws::String& GetDescription() const{ return m_description; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline UpdateRecommenderConfiguration& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline UpdateRecommenderConfiguration& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

    A custom description of the configuration for the recommender model. The - * description can contain up to 128 characters.

    + * description can contain up to 128 characters. The characters can be letters, + * numbers, spaces, or the following symbols: _ ; () , ‐.

    */ inline UpdateRecommenderConfiguration& WithDescription(const char* value) { SetDescription(value); return *this;} @@ -440,7 +461,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -456,7 +477,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -472,7 +493,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -488,7 +509,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -504,7 +525,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -520,7 +541,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -536,7 +557,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -552,7 +573,7 @@ namespace Model * value.

  • PINPOINT_USER_ID - Associate each user in the model with * a particular user and endpoint in Amazon Pinpoint. The data is correlated based * on user IDs in Amazon Pinpoint. If you specify this value, an endpoint - * definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an + * definition in Amazon Pinpoint has to specify both a user ID (UserId) and an * endpoint ID. Otherwise, messages won’t be sent to the user's * endpoint.

    • */ @@ -732,150 +753,154 @@ namespace Model /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline const Aws::String& GetRecommendationsDisplayName() const{ return m_recommendationsDisplayName; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline bool RecommendationsDisplayNameHasBeenSet() const { return m_recommendationsDisplayNameHasBeenSet; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(const Aws::String& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = value; } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(Aws::String&& value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName = std::move(value); } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline void SetRecommendationsDisplayName(const char* value) { m_recommendationsDisplayNameHasBeenSet = true; m_recommendationsDisplayName.assign(value); } /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline UpdateRecommenderConfiguration& WithRecommendationsDisplayName(const Aws::String& value) { SetRecommendationsDisplayName(value); return *this;} /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline UpdateRecommenderConfiguration& WithRecommendationsDisplayName(Aws::String&& value) { SetRecommendationsDisplayName(std::move(value)); return *this;} /** *

    A custom display name for the standard endpoint or user attribute - * (RecommendationItems) that temporarily stores a recommended item for each - * endpoint or user, depending on the value for the RecommenderUserIdType property. - * This value is required if the configuration doesn't invoke an AWS Lambda - * function (LambdaFunctionArn) to perform additional processing of recommendation - * data.

    This name appears in the Attribute finder pane of the - * template editor on the Amazon Pinpoint console. The name can contain up to 25 - * characters. The characters can be letters, numbers, spaces, underscores (_), or - * hyphens (-). These restrictions don't apply to attribute values.

    + * (RecommendationItems) that temporarily stores recommended items for each + * endpoint or user, depending on the value for the RecommendationProviderIdType + * property. This value is required if the configuration doesn't invoke an AWS + * Lambda function (RecommendationTransformerUri) to perform additional processing + * of recommendation data.

    This name appears in the Attribute finder + * of the template editor on the Amazon Pinpoint console. The name can contain up + * to 25 characters. The characters can be letters, numbers, spaces, underscores + * (_), or hyphens (-). These restrictions don't apply to attribute values.

    */ inline UpdateRecommenderConfiguration& WithRecommendationsDisplayName(const char* value) { SetRecommendationsDisplayName(value); return *this;} /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline int GetRecommendationsPerMessage() const{ return m_recommendationsPerMessage; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline bool RecommendationsPerMessageHasBeenSet() const { return m_recommendationsPerMessageHasBeenSet; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline void SetRecommendationsPerMessage(int value) { m_recommendationsPerMessageHasBeenSet = true; m_recommendationsPerMessage = value; } /** *

    The number of recommended items to retrieve from the model for each endpoint - * or user, depending on the value for the RecommenderUserIdType property. This - * number determines how many recommended attributes are available for use as - * message variables in message templates. The minimum value is 1. The maximum - * value is 5. The default value is 5.

    To use multiple recommended items and - * custom attributes with message variables, you have to use an AWS Lambda function - * (LambdaFunctionArn) to perform additional processing of recommendation data.

    + * or user, depending on the value for the RecommendationProviderIdType property. + * This number determines how many recommended items are available for use in + * message variables. The minimum value is 1. The maximum value is 5. The default + * value is 5.

    To use multiple recommended items and custom attributes with + * message variables, you have to use an AWS Lambda function + * (RecommendationTransformerUri) to perform additional processing of + * recommendation data.

    */ inline UpdateRecommenderConfiguration& WithRecommendationsPerMessage(int value) { SetRecommendationsPerMessage(value); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteApplicationSettingsRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteApplicationSettingsRequest.h index 3a585be189c..da18d85e0fd 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteApplicationSettingsRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteApplicationSettingsRequest.h @@ -51,56 +51,68 @@ namespace Model /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline const CampaignHook& GetCampaignHook() const{ return m_campaignHook; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline bool CampaignHookHasBeenSet() const { return m_campaignHookHasBeenSet; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline void SetCampaignHook(const CampaignHook& value) { m_campaignHookHasBeenSet = true; m_campaignHook = value; } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline void SetCampaignHook(CampaignHook&& value) { m_campaignHookHasBeenSet = true; m_campaignHook = std::move(value); } /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline WriteApplicationSettingsRequest& WithCampaignHook(const CampaignHook& value) { SetCampaignHook(value); return *this;} /** - *

    The settings for the AWS Lambda function to use by default as a code hook for - * campaigns in the application. To override these settings for a specific - * campaign, use the Campaign resource to - * define custom Lambda function settings for the campaign.

    + *

    The settings for the AWS Lambda function to invoke by default as a code hook + * for campaigns in the application. You can use this hook to customize segments + * that are used by campaigns in the application.

    To override these settings + * and define custom settings for a specific campaign, use the CampaignHook object + * of the Campaign + * resource.

    */ inline WriteApplicationSettingsRequest& WithCampaignHook(CampaignHook&& value) { SetCampaignHook(std::move(value)); return *this;} @@ -131,50 +143,62 @@ namespace Model /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline const CampaignLimits& GetLimits() const{ return m_limits; } /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline bool LimitsHasBeenSet() const { return m_limitsHasBeenSet; } /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline void SetLimits(const CampaignLimits& value) { m_limitsHasBeenSet = true; m_limits = value; } /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline void SetLimits(CampaignLimits&& value) { m_limitsHasBeenSet = true; m_limits = std::move(value); } /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline WriteApplicationSettingsRequest& WithLimits(const CampaignLimits& value) { SetLimits(value); return *this;} /** - *

    The default sending limits for campaigns in the application. To override - * these limits for a specific campaign, use the Campaign resource to - * define custom limits for the campaign.

    + *

    The default sending limits for campaigns and journeys in the application. To + * override these limits and define custom limits for a specific campaign or + * journey, use the Campaign resource or + * the Journey + * resource, respectively.

    */ inline WriteApplicationSettingsRequest& WithLimits(CampaignLimits&& value) { SetLimits(std::move(value)); return *this;} diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteCampaignRequest.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteCampaignRequest.h index 7db0e6b0797..4a67094f723 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteCampaignRequest.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteCampaignRequest.h @@ -16,6 +16,7 @@ #pragma once #include #include +#include #include #include #include @@ -105,6 +106,49 @@ namespace Model inline WriteCampaignRequest& AddAdditionalTreatments(WriteTreatmentResource&& value) { m_additionalTreatmentsHasBeenSet = true; m_additionalTreatments.push_back(std::move(value)); return *this; } + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline const CustomDeliveryConfiguration& GetCustomDeliveryConfiguration() const{ return m_customDeliveryConfiguration; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline bool CustomDeliveryConfigurationHasBeenSet() const { return m_customDeliveryConfigurationHasBeenSet; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = value; } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = std::move(value); } + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline WriteCampaignRequest& WithCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { SetCustomDeliveryConfiguration(value); return *this;} + + /** + *

    The delivery configuration settings for sending the campaign through a custom + * channel. This object is required if the MessageConfiguration object for the + * campaign specifies a CustomMessage object.

    + */ + inline WriteCampaignRequest& WithCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { SetCustomDeliveryConfiguration(std::move(value)); return *this;} + + /** *

    A custom description of the campaign.

    */ @@ -172,37 +216,43 @@ namespace Model /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline const CampaignHook& GetHook() const{ return m_hook; } /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline bool HookHasBeenSet() const { return m_hookHasBeenSet; } /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline void SetHook(const CampaignHook& value) { m_hookHasBeenSet = true; m_hook = value; } /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline void SetHook(CampaignHook&& value) { m_hookHasBeenSet = true; m_hook = std::move(value); } /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline WriteCampaignRequest& WithHook(const CampaignHook& value) { SetHook(value); return *this;} /** - *

    The settings for the AWS Lambda function to use as a code hook for the + *

    The settings for the AWS Lambda function to invoke as a code hook for the + * campaign. You can use this hook to customize the segment that's used by the * campaign.

    */ inline WriteCampaignRequest& WithHook(CampaignHook&& value) { SetHook(std::move(value)); return *this;} @@ -210,25 +260,25 @@ namespace Model /** *

    Specifies whether to pause the campaign. A paused campaign doesn't run unless - * you resume it by setting this value to false.

    + * you resume it by changing this value to false.

    */ inline bool GetIsPaused() const{ return m_isPaused; } /** *

    Specifies whether to pause the campaign. A paused campaign doesn't run unless - * you resume it by setting this value to false.

    + * you resume it by changing this value to false.

    */ inline bool IsPausedHasBeenSet() const { return m_isPausedHasBeenSet; } /** *

    Specifies whether to pause the campaign. A paused campaign doesn't run unless - * you resume it by setting this value to false.

    + * you resume it by changing this value to false.

    */ inline void SetIsPaused(bool value) { m_isPausedHasBeenSet = true; m_isPaused = value; } /** *

    Specifies whether to pause the campaign. A paused campaign doesn't run unless - * you resume it by setting this value to false.

    + * you resume it by changing this value to false.

    */ inline WriteCampaignRequest& WithIsPaused(bool value) { SetIsPaused(value); return *this;} @@ -553,91 +603,99 @@ namespace Model /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline const Aws::String& GetTreatmentDescription() const{ return m_treatmentDescription; } /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline bool TreatmentDescriptionHasBeenSet() const { return m_treatmentDescriptionHasBeenSet; } /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(const Aws::String& value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription = value; } /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(Aws::String&& value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription = std::move(value); } /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline void SetTreatmentDescription(const char* value) { m_treatmentDescriptionHasBeenSet = true; m_treatmentDescription.assign(value); } /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline WriteCampaignRequest& WithTreatmentDescription(const Aws::String& value) { SetTreatmentDescription(value); return *this;} /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline WriteCampaignRequest& WithTreatmentDescription(Aws::String&& value) { SetTreatmentDescription(std::move(value)); return *this;} /** - *

    A custom description of a variation of the campaign to use for A/B - * testing.

    + *

    A custom description of the default treatment for the campaign.

    */ inline WriteCampaignRequest& WithTreatmentDescription(const char* value) { SetTreatmentDescription(value); return *this;} /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline const Aws::String& GetTreatmentName() const{ return m_treatmentName; } /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline bool TreatmentNameHasBeenSet() const { return m_treatmentNameHasBeenSet; } /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline void SetTreatmentName(const Aws::String& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = value; } /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline void SetTreatmentName(Aws::String&& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = std::move(value); } /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline void SetTreatmentName(const char* value) { m_treatmentNameHasBeenSet = true; m_treatmentName.assign(value); } /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline WriteCampaignRequest& WithTreatmentName(const Aws::String& value) { SetTreatmentName(value); return *this;} /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline WriteCampaignRequest& WithTreatmentName(Aws::String&& value) { SetTreatmentName(std::move(value)); return *this;} /** - *

    A custom name for a variation of the campaign to use for A/B testing.

    + *

    A custom name of the default treatment for the campaign, if the campaign has + * multiple treatments. A treatment is a variation of a campaign that's used + * for A/B testing.

    */ inline WriteCampaignRequest& WithTreatmentName(const char* value) { SetTreatmentName(value); return *this;} @@ -646,6 +704,9 @@ namespace Model Aws::Vector m_additionalTreatments; bool m_additionalTreatmentsHasBeenSet; + CustomDeliveryConfiguration m_customDeliveryConfiguration; + bool m_customDeliveryConfigurationHasBeenSet; + Aws::String m_description; bool m_descriptionHasBeenSet; diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteTreatmentResource.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteTreatmentResource.h index a2c3d087f77..2f9d41f2eef 100644 --- a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteTreatmentResource.h +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/WriteTreatmentResource.h @@ -15,6 +15,7 @@ #pragma once #include +#include #include #include #include @@ -37,8 +38,8 @@ namespace Model { /** - *

    Specifies the settings for a campaign treatment. A treatment is a variation - * of a campaign that's used for A/B testing of a campaign.

    See + *

    Specifies the settings for a campaign treatment. A treatment is a + * variation of a campaign that's used for A/B testing of a campaign.

    See * Also:

    AWS * API Reference

    @@ -52,6 +53,49 @@ namespace Model Aws::Utils::Json::JsonValue Jsonize() const; + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline const CustomDeliveryConfiguration& GetCustomDeliveryConfiguration() const{ return m_customDeliveryConfiguration; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline bool CustomDeliveryConfigurationHasBeenSet() const { return m_customDeliveryConfigurationHasBeenSet; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = value; } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline void SetCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { m_customDeliveryConfigurationHasBeenSet = true; m_customDeliveryConfiguration = std::move(value); } + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline WriteTreatmentResource& WithCustomDeliveryConfiguration(const CustomDeliveryConfiguration& value) { SetCustomDeliveryConfiguration(value); return *this;} + + /** + *

    The delivery configuration settings for sending the treatment through a + * custom channel. This object is required if the MessageConfiguration object for + * the treatment specifies a CustomMessage object.

    + */ + inline WriteTreatmentResource& WithCustomDeliveryConfiguration(CustomDeliveryConfiguration&& value) { SetCustomDeliveryConfiguration(std::move(value)); return *this;} + + /** *

    The message configuration settings for the treatment.

    */ @@ -212,55 +256,50 @@ namespace Model /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline const Aws::String& GetTreatmentName() const{ return m_treatmentName; } /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline bool TreatmentNameHasBeenSet() const { return m_treatmentNameHasBeenSet; } /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline void SetTreatmentName(const Aws::String& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = value; } /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline void SetTreatmentName(Aws::String&& value) { m_treatmentNameHasBeenSet = true; m_treatmentName = std::move(value); } /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline void SetTreatmentName(const char* value) { m_treatmentNameHasBeenSet = true; m_treatmentName.assign(value); } /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline WriteTreatmentResource& WithTreatmentName(const Aws::String& value) { SetTreatmentName(value); return *this;} /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline WriteTreatmentResource& WithTreatmentName(Aws::String&& value) { SetTreatmentName(std::move(value)); return *this;} /** - *

    A custom name for the treatment. A treatment is a variation of a campaign - * that's used for A/B testing of a campaign.

    + *

    A custom name for the treatment.

    */ inline WriteTreatmentResource& WithTreatmentName(const char* value) { SetTreatmentName(value); return *this;} private: + CustomDeliveryConfiguration m_customDeliveryConfiguration; + bool m_customDeliveryConfigurationHasBeenSet; + MessageConfiguration m_messageConfiguration; bool m_messageConfigurationHasBeenSet; diff --git a/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/__EndpointTypesElement.h b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/__EndpointTypesElement.h new file mode 100644 index 00000000000..d6dff6bedcf --- /dev/null +++ b/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/__EndpointTypesElement.h @@ -0,0 +1,50 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include + +namespace Aws +{ +namespace Pinpoint +{ +namespace Model +{ + enum class __EndpointTypesElement + { + NOT_SET, + GCM, + APNS, + APNS_SANDBOX, + APNS_VOIP, + APNS_VOIP_SANDBOX, + ADM, + SMS, + VOICE, + EMAIL, + BAIDU, + CUSTOM + }; + +namespace __EndpointTypesElementMapper +{ +AWS_PINPOINT_API __EndpointTypesElement Get__EndpointTypesElementForName(const Aws::String& name); + +AWS_PINPOINT_API Aws::String GetNameFor__EndpointTypesElement(__EndpointTypesElement value); +} // namespace __EndpointTypesElementMapper +} // namespace Model +} // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-pinpoint/source/model/CampaignCustomMessage.cpp b/aws-cpp-sdk-pinpoint/source/model/CampaignCustomMessage.cpp new file mode 100644 index 00000000000..f797b74b9db --- /dev/null +++ b/aws-cpp-sdk-pinpoint/source/model/CampaignCustomMessage.cpp @@ -0,0 +1,69 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace Pinpoint +{ +namespace Model +{ + +CampaignCustomMessage::CampaignCustomMessage() : + m_dataHasBeenSet(false) +{ +} + +CampaignCustomMessage::CampaignCustomMessage(JsonView jsonValue) : + m_dataHasBeenSet(false) +{ + *this = jsonValue; +} + +CampaignCustomMessage& CampaignCustomMessage::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("Data")) + { + m_data = jsonValue.GetString("Data"); + + m_dataHasBeenSet = true; + } + + return *this; +} + +JsonValue CampaignCustomMessage::Jsonize() const +{ + JsonValue payload; + + if(m_dataHasBeenSet) + { + payload.WithString("Data", m_data); + + } + + return payload; +} + +} // namespace Model +} // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-pinpoint/source/model/CampaignResponse.cpp b/aws-cpp-sdk-pinpoint/source/model/CampaignResponse.cpp index 21777b6a9da..edae12105e3 100644 --- a/aws-cpp-sdk-pinpoint/source/model/CampaignResponse.cpp +++ b/aws-cpp-sdk-pinpoint/source/model/CampaignResponse.cpp @@ -33,6 +33,7 @@ CampaignResponse::CampaignResponse() : m_applicationIdHasBeenSet(false), m_arnHasBeenSet(false), m_creationDateHasBeenSet(false), + m_customDeliveryConfigurationHasBeenSet(false), m_defaultStateHasBeenSet(false), m_descriptionHasBeenSet(false), m_holdoutPercent(0), @@ -64,6 +65,7 @@ CampaignResponse::CampaignResponse(JsonView jsonValue) : m_applicationIdHasBeenSet(false), m_arnHasBeenSet(false), m_creationDateHasBeenSet(false), + m_customDeliveryConfigurationHasBeenSet(false), m_defaultStateHasBeenSet(false), m_descriptionHasBeenSet(false), m_holdoutPercent(0), @@ -124,6 +126,13 @@ CampaignResponse& CampaignResponse::operator =(JsonView jsonValue) m_creationDateHasBeenSet = true; } + if(jsonValue.ValueExists("CustomDeliveryConfiguration")) + { + m_customDeliveryConfiguration = jsonValue.GetObject("CustomDeliveryConfiguration"); + + m_customDeliveryConfigurationHasBeenSet = true; + } + if(jsonValue.ValueExists("DefaultState")) { m_defaultState = jsonValue.GetObject("DefaultState"); @@ -296,6 +305,12 @@ JsonValue CampaignResponse::Jsonize() const } + if(m_customDeliveryConfigurationHasBeenSet) + { + payload.WithObject("CustomDeliveryConfiguration", m_customDeliveryConfiguration.Jsonize()); + + } + if(m_defaultStateHasBeenSet) { payload.WithObject("DefaultState", m_defaultState.Jsonize()); diff --git a/aws-cpp-sdk-pinpoint/source/model/CustomDeliveryConfiguration.cpp b/aws-cpp-sdk-pinpoint/source/model/CustomDeliveryConfiguration.cpp new file mode 100644 index 00000000000..7ed693c0dbc --- /dev/null +++ b/aws-cpp-sdk-pinpoint/source/model/CustomDeliveryConfiguration.cpp @@ -0,0 +1,92 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace Pinpoint +{ +namespace Model +{ + +CustomDeliveryConfiguration::CustomDeliveryConfiguration() : + m_deliveryUriHasBeenSet(false), + m_endpointTypesHasBeenSet(false) +{ +} + +CustomDeliveryConfiguration::CustomDeliveryConfiguration(JsonView jsonValue) : + m_deliveryUriHasBeenSet(false), + m_endpointTypesHasBeenSet(false) +{ + *this = jsonValue; +} + +CustomDeliveryConfiguration& CustomDeliveryConfiguration::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("DeliveryUri")) + { + m_deliveryUri = jsonValue.GetString("DeliveryUri"); + + m_deliveryUriHasBeenSet = true; + } + + if(jsonValue.ValueExists("EndpointTypes")) + { + Array endpointTypesJsonList = jsonValue.GetArray("EndpointTypes"); + for(unsigned endpointTypesIndex = 0; endpointTypesIndex < endpointTypesJsonList.GetLength(); ++endpointTypesIndex) + { + m_endpointTypes.push_back(__EndpointTypesElementMapper::Get__EndpointTypesElementForName(endpointTypesJsonList[endpointTypesIndex].AsString())); + } + m_endpointTypesHasBeenSet = true; + } + + return *this; +} + +JsonValue CustomDeliveryConfiguration::Jsonize() const +{ + JsonValue payload; + + if(m_deliveryUriHasBeenSet) + { + payload.WithString("DeliveryUri", m_deliveryUri); + + } + + if(m_endpointTypesHasBeenSet) + { + Array endpointTypesJsonList(m_endpointTypes.size()); + for(unsigned endpointTypesIndex = 0; endpointTypesIndex < endpointTypesJsonList.GetLength(); ++endpointTypesIndex) + { + endpointTypesJsonList[endpointTypesIndex].AsString(__EndpointTypesElementMapper::GetNameFor__EndpointTypesElement(m_endpointTypes[endpointTypesIndex])); + } + payload.WithArray("EndpointTypes", std::move(endpointTypesJsonList)); + + } + + return payload; +} + +} // namespace Model +} // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-pinpoint/source/model/MessageConfiguration.cpp b/aws-cpp-sdk-pinpoint/source/model/MessageConfiguration.cpp index d90ff3bfc17..2b6668a5071 100644 --- a/aws-cpp-sdk-pinpoint/source/model/MessageConfiguration.cpp +++ b/aws-cpp-sdk-pinpoint/source/model/MessageConfiguration.cpp @@ -32,6 +32,7 @@ MessageConfiguration::MessageConfiguration() : m_aDMMessageHasBeenSet(false), m_aPNSMessageHasBeenSet(false), m_baiduMessageHasBeenSet(false), + m_customMessageHasBeenSet(false), m_defaultMessageHasBeenSet(false), m_emailMessageHasBeenSet(false), m_gCMMessageHasBeenSet(false), @@ -43,6 +44,7 @@ MessageConfiguration::MessageConfiguration(JsonView jsonValue) : m_aDMMessageHasBeenSet(false), m_aPNSMessageHasBeenSet(false), m_baiduMessageHasBeenSet(false), + m_customMessageHasBeenSet(false), m_defaultMessageHasBeenSet(false), m_emailMessageHasBeenSet(false), m_gCMMessageHasBeenSet(false), @@ -74,6 +76,13 @@ MessageConfiguration& MessageConfiguration::operator =(JsonView jsonValue) m_baiduMessageHasBeenSet = true; } + if(jsonValue.ValueExists("CustomMessage")) + { + m_customMessage = jsonValue.GetObject("CustomMessage"); + + m_customMessageHasBeenSet = true; + } + if(jsonValue.ValueExists("DefaultMessage")) { m_defaultMessage = jsonValue.GetObject("DefaultMessage"); @@ -127,6 +136,12 @@ JsonValue MessageConfiguration::Jsonize() const } + if(m_customMessageHasBeenSet) + { + payload.WithObject("CustomMessage", m_customMessage.Jsonize()); + + } + if(m_defaultMessageHasBeenSet) { payload.WithObject("DefaultMessage", m_defaultMessage.Jsonize()); diff --git a/aws-cpp-sdk-pinpoint/source/model/TreatmentResource.cpp b/aws-cpp-sdk-pinpoint/source/model/TreatmentResource.cpp index d4cb62253dc..edad1fec4cb 100644 --- a/aws-cpp-sdk-pinpoint/source/model/TreatmentResource.cpp +++ b/aws-cpp-sdk-pinpoint/source/model/TreatmentResource.cpp @@ -29,6 +29,7 @@ namespace Model { TreatmentResource::TreatmentResource() : + m_customDeliveryConfigurationHasBeenSet(false), m_idHasBeenSet(false), m_messageConfigurationHasBeenSet(false), m_scheduleHasBeenSet(false), @@ -42,6 +43,7 @@ TreatmentResource::TreatmentResource() : } TreatmentResource::TreatmentResource(JsonView jsonValue) : + m_customDeliveryConfigurationHasBeenSet(false), m_idHasBeenSet(false), m_messageConfigurationHasBeenSet(false), m_scheduleHasBeenSet(false), @@ -57,6 +59,13 @@ TreatmentResource::TreatmentResource(JsonView jsonValue) : TreatmentResource& TreatmentResource::operator =(JsonView jsonValue) { + if(jsonValue.ValueExists("CustomDeliveryConfiguration")) + { + m_customDeliveryConfiguration = jsonValue.GetObject("CustomDeliveryConfiguration"); + + m_customDeliveryConfigurationHasBeenSet = true; + } + if(jsonValue.ValueExists("Id")) { m_id = jsonValue.GetString("Id"); @@ -120,6 +129,12 @@ JsonValue TreatmentResource::Jsonize() const { JsonValue payload; + if(m_customDeliveryConfigurationHasBeenSet) + { + payload.WithObject("CustomDeliveryConfiguration", m_customDeliveryConfiguration.Jsonize()); + + } + if(m_idHasBeenSet) { payload.WithString("Id", m_id); diff --git a/aws-cpp-sdk-pinpoint/source/model/WriteCampaignRequest.cpp b/aws-cpp-sdk-pinpoint/source/model/WriteCampaignRequest.cpp index b3685f21efe..0a98413eeea 100644 --- a/aws-cpp-sdk-pinpoint/source/model/WriteCampaignRequest.cpp +++ b/aws-cpp-sdk-pinpoint/source/model/WriteCampaignRequest.cpp @@ -30,6 +30,7 @@ namespace Model WriteCampaignRequest::WriteCampaignRequest() : m_additionalTreatmentsHasBeenSet(false), + m_customDeliveryConfigurationHasBeenSet(false), m_descriptionHasBeenSet(false), m_holdoutPercent(0), m_holdoutPercentHasBeenSet(false), @@ -52,6 +53,7 @@ WriteCampaignRequest::WriteCampaignRequest() : WriteCampaignRequest::WriteCampaignRequest(JsonView jsonValue) : m_additionalTreatmentsHasBeenSet(false), + m_customDeliveryConfigurationHasBeenSet(false), m_descriptionHasBeenSet(false), m_holdoutPercent(0), m_holdoutPercentHasBeenSet(false), @@ -85,6 +87,13 @@ WriteCampaignRequest& WriteCampaignRequest::operator =(JsonView jsonValue) m_additionalTreatmentsHasBeenSet = true; } + if(jsonValue.ValueExists("CustomDeliveryConfiguration")) + { + m_customDeliveryConfiguration = jsonValue.GetObject("CustomDeliveryConfiguration"); + + m_customDeliveryConfigurationHasBeenSet = true; + } + if(jsonValue.ValueExists("Description")) { m_description = jsonValue.GetString("Description"); @@ -204,6 +213,12 @@ JsonValue WriteCampaignRequest::Jsonize() const } + if(m_customDeliveryConfigurationHasBeenSet) + { + payload.WithObject("CustomDeliveryConfiguration", m_customDeliveryConfiguration.Jsonize()); + + } + if(m_descriptionHasBeenSet) { payload.WithString("Description", m_description); diff --git a/aws-cpp-sdk-pinpoint/source/model/WriteTreatmentResource.cpp b/aws-cpp-sdk-pinpoint/source/model/WriteTreatmentResource.cpp index 05aeb45af58..dbbfb27d5a2 100644 --- a/aws-cpp-sdk-pinpoint/source/model/WriteTreatmentResource.cpp +++ b/aws-cpp-sdk-pinpoint/source/model/WriteTreatmentResource.cpp @@ -29,6 +29,7 @@ namespace Model { WriteTreatmentResource::WriteTreatmentResource() : + m_customDeliveryConfigurationHasBeenSet(false), m_messageConfigurationHasBeenSet(false), m_scheduleHasBeenSet(false), m_sizePercent(0), @@ -40,6 +41,7 @@ WriteTreatmentResource::WriteTreatmentResource() : } WriteTreatmentResource::WriteTreatmentResource(JsonView jsonValue) : + m_customDeliveryConfigurationHasBeenSet(false), m_messageConfigurationHasBeenSet(false), m_scheduleHasBeenSet(false), m_sizePercent(0), @@ -53,6 +55,13 @@ WriteTreatmentResource::WriteTreatmentResource(JsonView jsonValue) : WriteTreatmentResource& WriteTreatmentResource::operator =(JsonView jsonValue) { + if(jsonValue.ValueExists("CustomDeliveryConfiguration")) + { + m_customDeliveryConfiguration = jsonValue.GetObject("CustomDeliveryConfiguration"); + + m_customDeliveryConfigurationHasBeenSet = true; + } + if(jsonValue.ValueExists("MessageConfiguration")) { m_messageConfiguration = jsonValue.GetObject("MessageConfiguration"); @@ -102,6 +111,12 @@ JsonValue WriteTreatmentResource::Jsonize() const { JsonValue payload; + if(m_customDeliveryConfigurationHasBeenSet) + { + payload.WithObject("CustomDeliveryConfiguration", m_customDeliveryConfiguration.Jsonize()); + + } + if(m_messageConfigurationHasBeenSet) { payload.WithObject("MessageConfiguration", m_messageConfiguration.Jsonize()); diff --git a/aws-cpp-sdk-pinpoint/source/model/__EndpointTypesElement.cpp b/aws-cpp-sdk-pinpoint/source/model/__EndpointTypesElement.cpp new file mode 100644 index 00000000000..eafb87c1e27 --- /dev/null +++ b/aws-cpp-sdk-pinpoint/source/model/__EndpointTypesElement.cpp @@ -0,0 +1,143 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include + +using namespace Aws::Utils; + + +namespace Aws +{ + namespace Pinpoint + { + namespace Model + { + namespace __EndpointTypesElementMapper + { + + static const int GCM_HASH = HashingUtils::HashString("GCM"); + static const int APNS_HASH = HashingUtils::HashString("APNS"); + static const int APNS_SANDBOX_HASH = HashingUtils::HashString("APNS_SANDBOX"); + static const int APNS_VOIP_HASH = HashingUtils::HashString("APNS_VOIP"); + static const int APNS_VOIP_SANDBOX_HASH = HashingUtils::HashString("APNS_VOIP_SANDBOX"); + static const int ADM_HASH = HashingUtils::HashString("ADM"); + static const int SMS_HASH = HashingUtils::HashString("SMS"); + static const int VOICE_HASH = HashingUtils::HashString("VOICE"); + static const int EMAIL_HASH = HashingUtils::HashString("EMAIL"); + static const int BAIDU_HASH = HashingUtils::HashString("BAIDU"); + static const int CUSTOM_HASH = HashingUtils::HashString("CUSTOM"); + + + __EndpointTypesElement Get__EndpointTypesElementForName(const Aws::String& name) + { + int hashCode = HashingUtils::HashString(name.c_str()); + if (hashCode == GCM_HASH) + { + return __EndpointTypesElement::GCM; + } + else if (hashCode == APNS_HASH) + { + return __EndpointTypesElement::APNS; + } + else if (hashCode == APNS_SANDBOX_HASH) + { + return __EndpointTypesElement::APNS_SANDBOX; + } + else if (hashCode == APNS_VOIP_HASH) + { + return __EndpointTypesElement::APNS_VOIP; + } + else if (hashCode == APNS_VOIP_SANDBOX_HASH) + { + return __EndpointTypesElement::APNS_VOIP_SANDBOX; + } + else if (hashCode == ADM_HASH) + { + return __EndpointTypesElement::ADM; + } + else if (hashCode == SMS_HASH) + { + return __EndpointTypesElement::SMS; + } + else if (hashCode == VOICE_HASH) + { + return __EndpointTypesElement::VOICE; + } + else if (hashCode == EMAIL_HASH) + { + return __EndpointTypesElement::EMAIL; + } + else if (hashCode == BAIDU_HASH) + { + return __EndpointTypesElement::BAIDU; + } + else if (hashCode == CUSTOM_HASH) + { + return __EndpointTypesElement::CUSTOM; + } + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if(overflowContainer) + { + overflowContainer->StoreOverflow(hashCode, name); + return static_cast<__EndpointTypesElement>(hashCode); + } + + return __EndpointTypesElement::NOT_SET; + } + + Aws::String GetNameFor__EndpointTypesElement(__EndpointTypesElement enumValue) + { + switch(enumValue) + { + case __EndpointTypesElement::GCM: + return "GCM"; + case __EndpointTypesElement::APNS: + return "APNS"; + case __EndpointTypesElement::APNS_SANDBOX: + return "APNS_SANDBOX"; + case __EndpointTypesElement::APNS_VOIP: + return "APNS_VOIP"; + case __EndpointTypesElement::APNS_VOIP_SANDBOX: + return "APNS_VOIP_SANDBOX"; + case __EndpointTypesElement::ADM: + return "ADM"; + case __EndpointTypesElement::SMS: + return "SMS"; + case __EndpointTypesElement::VOICE: + return "VOICE"; + case __EndpointTypesElement::EMAIL: + return "EMAIL"; + case __EndpointTypesElement::BAIDU: + return "BAIDU"; + case __EndpointTypesElement::CUSTOM: + return "CUSTOM"; + default: + EnumParseOverflowContainer* overflowContainer = Aws::GetEnumOverflowContainer(); + if(overflowContainer) + { + return overflowContainer->RetrieveOverflow(static_cast(enumValue)); + } + + return {}; + } + } + + } // namespace __EndpointTypesElementMapper + } // namespace Model + } // namespace Pinpoint +} // namespace Aws diff --git a/aws-cpp-sdk-ram/include/aws/ram/RAMClient.h b/aws-cpp-sdk-ram/include/aws/ram/RAMClient.h index 16059a1dbda..803e0433d38 100644 --- a/aws-cpp-sdk-ram/include/aws/ram/RAMClient.h +++ b/aws-cpp-sdk-ram/include/aws/ram/RAMClient.h @@ -38,6 +38,7 @@ #include #include #include +#include #include #include #include @@ -100,6 +101,7 @@ namespace Model class ListPermissionsRequest; class ListPrincipalsRequest; class ListResourceSharePermissionsRequest; + class ListResourceTypesRequest; class ListResourcesRequest; class PromoteResourceShareCreatedFromPolicyRequest; class RejectResourceShareInvitationRequest; @@ -124,6 +126,7 @@ namespace Model typedef Aws::Utils::Outcome> ListPermissionsOutcome; typedef Aws::Utils::Outcome> ListPrincipalsOutcome; typedef Aws::Utils::Outcome> ListResourceSharePermissionsOutcome; + typedef Aws::Utils::Outcome> ListResourceTypesOutcome; typedef Aws::Utils::Outcome> ListResourcesOutcome; typedef Aws::Utils::Outcome> PromoteResourceShareCreatedFromPolicyOutcome; typedef Aws::Utils::Outcome> RejectResourceShareInvitationOutcome; @@ -148,6 +151,7 @@ namespace Model typedef std::future ListPermissionsOutcomeCallable; typedef std::future ListPrincipalsOutcomeCallable; typedef std::future ListResourceSharePermissionsOutcomeCallable; + typedef std::future ListResourceTypesOutcomeCallable; typedef std::future ListResourcesOutcomeCallable; typedef std::future PromoteResourceShareCreatedFromPolicyOutcomeCallable; typedef std::future RejectResourceShareInvitationOutcomeCallable; @@ -175,6 +179,7 @@ namespace Model typedef std::function&) > ListPermissionsResponseReceivedHandler; typedef std::function&) > ListPrincipalsResponseReceivedHandler; typedef std::function&) > ListResourceSharePermissionsResponseReceivedHandler; + typedef std::function&) > ListResourceTypesResponseReceivedHandler; typedef std::function&) > ListResourcesResponseReceivedHandler; typedef std::function&) > PromoteResourceShareCreatedFromPolicyResponseReceivedHandler; typedef std::function&) > RejectResourceShareInvitationResponseReceivedHandler; @@ -685,6 +690,34 @@ namespace Model */ virtual void ListResourceSharePermissionsAsync(const Model::ListResourceSharePermissionsRequest& request, const ListResourceSharePermissionsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** + *

    Lists the shareable resource types supported by AWS RAM.

    See + * Also:

    AWS + * API Reference

    + */ + virtual Model::ListResourceTypesOutcome ListResourceTypes(const Model::ListResourceTypesRequest& request) const; + + /** + *

    Lists the shareable resource types supported by AWS RAM.

    See + * Also:

    AWS + * API Reference

    + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::ListResourceTypesOutcomeCallable ListResourceTypesCallable(const Model::ListResourceTypesRequest& request) const; + + /** + *

    Lists the shareable resource types supported by AWS RAM.

    See + * Also:

    AWS + * API Reference

    + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void ListResourceTypesAsync(const Model::ListResourceTypesRequest& request, const ListResourceTypesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** *

    Lists the resources that you added to a resource shares or the resources that * are shared with you.

    See Also:

    & context) const; void ListPrincipalsAsyncHelper(const Model::ListPrincipalsRequest& request, const ListPrincipalsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListResourceSharePermissionsAsyncHelper(const Model::ListResourceSharePermissionsRequest& request, const ListResourceSharePermissionsResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void ListResourceTypesAsyncHelper(const Model::ListResourceTypesRequest& request, const ListResourceTypesResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListResourcesAsyncHelper(const Model::ListResourcesRequest& request, const ListResourcesResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PromoteResourceShareCreatedFromPolicyAsyncHelper(const Model::PromoteResourceShareCreatedFromPolicyRequest& request, const PromoteResourceShareCreatedFromPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void RejectResourceShareInvitationAsyncHelper(const Model::RejectResourceShareInvitationRequest& request, const RejectResourceShareInvitationResponseReceivedHandler& handler, const std::shared_ptr& context) const; diff --git a/aws-cpp-sdk-ram/include/aws/ram/model/ListPrincipalsRequest.h b/aws-cpp-sdk-ram/include/aws/ram/model/ListPrincipalsRequest.h index fb15e7993d6..f9b7ec94084 100644 --- a/aws-cpp-sdk-ram/include/aws/ram/model/ListPrincipalsRequest.h +++ b/aws-cpp-sdk-ram/include/aws/ram/model/ListPrincipalsRequest.h @@ -163,82 +163,106 @@ namespace Model /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline const Aws::String& GetResourceType() const{ return m_resourceType; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline bool ResourceTypeHasBeenSet() const { return m_resourceTypeHasBeenSet; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(const Aws::String& value) { m_resourceTypeHasBeenSet = true; m_resourceType = value; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(Aws::String&& value) { m_resourceTypeHasBeenSet = true; m_resourceType = std::move(value); } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(const char* value) { m_resourceTypeHasBeenSet = true; m_resourceType.assign(value); } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListPrincipalsRequest& WithResourceType(const Aws::String& value) { SetResourceType(value); return *this;} /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListPrincipalsRequest& WithResourceType(Aws::String&& value) { SetResourceType(std::move(value)); return *this;} /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule I resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListPrincipalsRequest& WithResourceType(const char* value) { SetResourceType(value); return *this;} diff --git a/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesRequest.h b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesRequest.h new file mode 100644 index 00000000000..9345a6907fd --- /dev/null +++ b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesRequest.h @@ -0,0 +1,125 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace RAM +{ +namespace Model +{ + + /** + */ + class AWS_RAM_API ListResourceTypesRequest : public RAMRequest + { + public: + ListResourceTypesRequest(); + + // 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 "ListResourceTypes"; } + + Aws::String SerializePayload() const override; + + + /** + *

    The token for the next page of results.

    + */ + inline const Aws::String& GetNextToken() const{ return m_nextToken; } + + /** + *

    The token for the next page of results.

    + */ + inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } + + /** + *

    The token for the next page of results.

    + */ + inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } + + /** + *

    The token for the next page of results.

    + */ + inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } + + /** + *

    The token for the next page of results.

    + */ + inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } + + /** + *

    The token for the next page of results.

    + */ + inline ListResourceTypesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} + + /** + *

    The token for the next page of results.

    + */ + inline ListResourceTypesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} + + /** + *

    The token for the next page of results.

    + */ + inline ListResourceTypesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} + + + /** + *

    The maximum number of results to return with a single call. To retrieve the + * remaining results, make another call with the returned nextToken + * value.

    + */ + inline int GetMaxResults() const{ return m_maxResults; } + + /** + *

    The maximum number of results to return with a single call. To retrieve the + * remaining results, make another call with the returned nextToken + * value.

    + */ + inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } + + /** + *

    The maximum number of results to return with a single call. To retrieve the + * remaining results, make another call with the returned nextToken + * value.

    + */ + inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } + + /** + *

    The maximum number of results to return with a single call. To retrieve the + * remaining results, make another call with the returned nextToken + * value.

    + */ + inline ListResourceTypesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} + + private: + + Aws::String m_nextToken; + bool m_nextTokenHasBeenSet; + + int m_maxResults; + bool m_maxResultsHasBeenSet; + }; + +} // namespace Model +} // namespace RAM +} // namespace Aws diff --git a/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesResult.h b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesResult.h new file mode 100644 index 00000000000..cb8a691969a --- /dev/null +++ b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourceTypesResult.h @@ -0,0 +1,134 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws +{ +template +class AmazonWebServiceResult; + +namespace Utils +{ +namespace Json +{ + class JsonValue; +} // namespace Json +} // namespace Utils +namespace RAM +{ +namespace Model +{ + class AWS_RAM_API ListResourceTypesResult + { + public: + ListResourceTypesResult(); + ListResourceTypesResult(const Aws::AmazonWebServiceResult& result); + ListResourceTypesResult& operator=(const Aws::AmazonWebServiceResult& result); + + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline const Aws::Vector& GetResourceTypes() const{ return m_resourceTypes; } + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline void SetResourceTypes(const Aws::Vector& value) { m_resourceTypes = value; } + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline void SetResourceTypes(Aws::Vector&& value) { m_resourceTypes = std::move(value); } + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline ListResourceTypesResult& WithResourceTypes(const Aws::Vector& value) { SetResourceTypes(value); return *this;} + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline ListResourceTypesResult& WithResourceTypes(Aws::Vector&& value) { SetResourceTypes(std::move(value)); return *this;} + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline ListResourceTypesResult& AddResourceTypes(const ServiceNameAndResourceType& value) { m_resourceTypes.push_back(value); return *this; } + + /** + *

    The shareable resource types supported by AWS RAM.

    + */ + inline ListResourceTypesResult& AddResourceTypes(ServiceNameAndResourceType&& value) { m_resourceTypes.push_back(std::move(value)); return *this; } + + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline const Aws::String& GetNextToken() const{ return m_nextToken; } + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline void SetNextToken(const Aws::String& value) { m_nextToken = value; } + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline void SetNextToken(Aws::String&& value) { m_nextToken = std::move(value); } + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline void SetNextToken(const char* value) { m_nextToken.assign(value); } + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline ListResourceTypesResult& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline ListResourceTypesResult& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} + + /** + *

    The token to use to retrieve the next page of results. This value is + * null when there are no more results to return.

    + */ + inline ListResourceTypesResult& WithNextToken(const char* value) { SetNextToken(value); return *this;} + + private: + + Aws::Vector m_resourceTypes; + + Aws::String m_nextToken; + }; + +} // namespace Model +} // namespace RAM +} // namespace Aws diff --git a/aws-cpp-sdk-ram/include/aws/ram/model/ListResourcesRequest.h b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourcesRequest.h index 0675a3b10a4..33829673713 100644 --- a/aws-cpp-sdk-ram/include/aws/ram/model/ListResourcesRequest.h +++ b/aws-cpp-sdk-ram/include/aws/ram/model/ListResourcesRequest.h @@ -117,82 +117,106 @@ namespace Model /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline const Aws::String& GetResourceType() const{ return m_resourceType; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline bool ResourceTypeHasBeenSet() const { return m_resourceTypeHasBeenSet; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(const Aws::String& value) { m_resourceTypeHasBeenSet = true; m_resourceType = value; } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(Aws::String&& value) { m_resourceTypeHasBeenSet = true; m_resourceType = std::move(value); } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline void SetResourceType(const char* value) { m_resourceTypeHasBeenSet = true; m_resourceType.assign(value); } /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListResourcesRequest& WithResourceType(const Aws::String& value) { SetResourceType(value); return *this;} /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListResourcesRequest& WithResourceType(Aws::String&& value) { SetResourceType(std::move(value)); return *this;} /** - *

    The resource type.

    Valid values: ec2:CapacityReservation - * | ec2:Subnet | ec2:TrafficMirrorTarget | - * ec2:TransitGateway | - * license-manager:LicenseConfiguration | rds:Cluster | - * route53resolver:ResolverRule | resource-groups:Group - *

    + *

    The resource type.

    Valid values: codebuild:Project | + * codebuild:ReportGroup | ec2:CapacityReservation | + * ec2:DedicatedHost | ec2:Subnet | + * ec2:TrafficMirrorTarget | ec2:TransitGateway | + * imagebuilder:Component | imagebuilder:Image | + * imagebuilder:ImageRecipe | + * license-manager:LicenseConfiguration I + * resource-groups:Group | rds:Cluster | + * route53resolver:ResolverRule

    */ inline ListResourcesRequest& WithResourceType(const char* value) { SetResourceType(value); return *this;} diff --git a/aws-cpp-sdk-ram/include/aws/ram/model/ServiceNameAndResourceType.h b/aws-cpp-sdk-ram/include/aws/ram/model/ServiceNameAndResourceType.h new file mode 100644 index 00000000000..0c3434cde28 --- /dev/null +++ b/aws-cpp-sdk-ram/include/aws/ram/model/ServiceNameAndResourceType.h @@ -0,0 +1,143 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace RAM +{ +namespace Model +{ + + /** + *

    Information about the shareable resource types and the AWS services to which + * they belong.

    See Also:

    AWS + * API Reference

    + */ + class AWS_RAM_API ServiceNameAndResourceType + { + public: + ServiceNameAndResourceType(); + ServiceNameAndResourceType(Aws::Utils::Json::JsonView jsonValue); + ServiceNameAndResourceType& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

    The shareable resource types.

    + */ + inline const Aws::String& GetResourceType() const{ return m_resourceType; } + + /** + *

    The shareable resource types.

    + */ + inline bool ResourceTypeHasBeenSet() const { return m_resourceTypeHasBeenSet; } + + /** + *

    The shareable resource types.

    + */ + inline void SetResourceType(const Aws::String& value) { m_resourceTypeHasBeenSet = true; m_resourceType = value; } + + /** + *

    The shareable resource types.

    + */ + inline void SetResourceType(Aws::String&& value) { m_resourceTypeHasBeenSet = true; m_resourceType = std::move(value); } + + /** + *

    The shareable resource types.

    + */ + inline void SetResourceType(const char* value) { m_resourceTypeHasBeenSet = true; m_resourceType.assign(value); } + + /** + *

    The shareable resource types.

    + */ + inline ServiceNameAndResourceType& WithResourceType(const Aws::String& value) { SetResourceType(value); return *this;} + + /** + *

    The shareable resource types.

    + */ + inline ServiceNameAndResourceType& WithResourceType(Aws::String&& value) { SetResourceType(std::move(value)); return *this;} + + /** + *

    The shareable resource types.

    + */ + inline ServiceNameAndResourceType& WithResourceType(const char* value) { SetResourceType(value); return *this;} + + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline const Aws::String& GetServiceName() const{ return m_serviceName; } + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline bool ServiceNameHasBeenSet() const { return m_serviceNameHasBeenSet; } + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline void SetServiceName(const Aws::String& value) { m_serviceNameHasBeenSet = true; m_serviceName = value; } + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline void SetServiceName(Aws::String&& value) { m_serviceNameHasBeenSet = true; m_serviceName = std::move(value); } + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline void SetServiceName(const char* value) { m_serviceNameHasBeenSet = true; m_serviceName.assign(value); } + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline ServiceNameAndResourceType& WithServiceName(const Aws::String& value) { SetServiceName(value); return *this;} + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline ServiceNameAndResourceType& WithServiceName(Aws::String&& value) { SetServiceName(std::move(value)); return *this;} + + /** + *

    The name of the AWS services to which the resources belong.

    + */ + inline ServiceNameAndResourceType& WithServiceName(const char* value) { SetServiceName(value); return *this;} + + private: + + Aws::String m_resourceType; + bool m_resourceTypeHasBeenSet; + + Aws::String m_serviceName; + bool m_serviceNameHasBeenSet; + }; + +} // namespace Model +} // namespace RAM +} // namespace Aws diff --git a/aws-cpp-sdk-ram/source/RAMClient.cpp b/aws-cpp-sdk-ram/source/RAMClient.cpp index ea16cbc84d4..20dbd33cad2 100644 --- a/aws-cpp-sdk-ram/source/RAMClient.cpp +++ b/aws-cpp-sdk-ram/source/RAMClient.cpp @@ -47,6 +47,7 @@ #include #include #include +#include #include #include #include @@ -726,6 +727,41 @@ void RAMClient::ListResourceSharePermissionsAsyncHelper(const ListResourceShareP handler(this, request, ListResourceSharePermissions(request), context); } +ListResourceTypesOutcome RAMClient::ListResourceTypes(const ListResourceTypesRequest& request) const +{ + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/listresourcetypes"; + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_POST, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return ListResourceTypesOutcome(ListResourceTypesResult(outcome.GetResult())); + } + else + { + return ListResourceTypesOutcome(outcome.GetError()); + } +} + +ListResourceTypesOutcomeCallable RAMClient::ListResourceTypesCallable(const ListResourceTypesRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< ListResourceTypesOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->ListResourceTypes(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void RAMClient::ListResourceTypesAsync(const ListResourceTypesRequest& request, const ListResourceTypesResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->ListResourceTypesAsyncHelper( request, handler, context ); } ); +} + +void RAMClient::ListResourceTypesAsyncHelper(const ListResourceTypesRequest& request, const ListResourceTypesResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, ListResourceTypes(request), context); +} + ListResourcesOutcome RAMClient::ListResources(const ListResourcesRequest& request) const { Aws::Http::URI uri = m_uri; diff --git a/aws-cpp-sdk-ram/source/model/ListResourceTypesRequest.cpp b/aws-cpp-sdk-ram/source/model/ListResourceTypesRequest.cpp new file mode 100644 index 00000000000..fb7980b7411 --- /dev/null +++ b/aws-cpp-sdk-ram/source/model/ListResourceTypesRequest.cpp @@ -0,0 +1,53 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::RAM::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +ListResourceTypesRequest::ListResourceTypesRequest() : + m_nextTokenHasBeenSet(false), + m_maxResults(0), + m_maxResultsHasBeenSet(false) +{ +} + +Aws::String ListResourceTypesRequest::SerializePayload() const +{ + JsonValue payload; + + if(m_nextTokenHasBeenSet) + { + payload.WithString("nextToken", m_nextToken); + + } + + if(m_maxResultsHasBeenSet) + { + payload.WithInteger("maxResults", m_maxResults); + + } + + return payload.View().WriteReadable(); +} + + + + diff --git a/aws-cpp-sdk-ram/source/model/ListResourceTypesResult.cpp b/aws-cpp-sdk-ram/source/model/ListResourceTypesResult.cpp new file mode 100644 index 00000000000..7d52f7f3da5 --- /dev/null +++ b/aws-cpp-sdk-ram/source/model/ListResourceTypesResult.cpp @@ -0,0 +1,59 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#include + +using namespace Aws::RAM::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ListResourceTypesResult::ListResourceTypesResult() +{ +} + +ListResourceTypesResult::ListResourceTypesResult(const Aws::AmazonWebServiceResult& result) +{ + *this = result; +} + +ListResourceTypesResult& ListResourceTypesResult::operator =(const Aws::AmazonWebServiceResult& result) +{ + JsonView jsonValue = result.GetPayload().View(); + if(jsonValue.ValueExists("resourceTypes")) + { + Array resourceTypesJsonList = jsonValue.GetArray("resourceTypes"); + for(unsigned resourceTypesIndex = 0; resourceTypesIndex < resourceTypesJsonList.GetLength(); ++resourceTypesIndex) + { + m_resourceTypes.push_back(resourceTypesJsonList[resourceTypesIndex].AsObject()); + } + } + + if(jsonValue.ValueExists("nextToken")) + { + m_nextToken = jsonValue.GetString("nextToken"); + + } + + + + return *this; +} diff --git a/aws-cpp-sdk-ram/source/model/ServiceNameAndResourceType.cpp b/aws-cpp-sdk-ram/source/model/ServiceNameAndResourceType.cpp new file mode 100644 index 00000000000..aa9a0c92930 --- /dev/null +++ b/aws-cpp-sdk-ram/source/model/ServiceNameAndResourceType.cpp @@ -0,0 +1,84 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace RAM +{ +namespace Model +{ + +ServiceNameAndResourceType::ServiceNameAndResourceType() : + m_resourceTypeHasBeenSet(false), + m_serviceNameHasBeenSet(false) +{ +} + +ServiceNameAndResourceType::ServiceNameAndResourceType(JsonView jsonValue) : + m_resourceTypeHasBeenSet(false), + m_serviceNameHasBeenSet(false) +{ + *this = jsonValue; +} + +ServiceNameAndResourceType& ServiceNameAndResourceType::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("resourceType")) + { + m_resourceType = jsonValue.GetString("resourceType"); + + m_resourceTypeHasBeenSet = true; + } + + if(jsonValue.ValueExists("serviceName")) + { + m_serviceName = jsonValue.GetString("serviceName"); + + m_serviceNameHasBeenSet = true; + } + + return *this; +} + +JsonValue ServiceNameAndResourceType::Jsonize() const +{ + JsonValue payload; + + if(m_resourceTypeHasBeenSet) + { + payload.WithString("resourceType", m_resourceType); + + } + + if(m_serviceNameHasBeenSet) + { + payload.WithString("serviceName", m_serviceName); + + } + + return payload; +} + +} // namespace Model +} // namespace RAM +} // namespace Aws diff --git a/aws-cpp-sdk-rds/include/aws/rds/RDSClient.h b/aws-cpp-sdk-rds/include/aws/rds/RDSClient.h index a6e15ebd1d6..1a77af64d63 100644 --- a/aws-cpp-sdk-rds/include/aws/rds/RDSClient.h +++ b/aws-cpp-sdk-rds/include/aws/rds/RDSClient.h @@ -5536,8 +5536,17 @@ namespace Aws * be created using the Percona XtraBackup utility as described in * Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora - * User Guide.

    This action only applies to Aurora DB - * clusters.

    See Also:

    .

    This action only restores the DB cluster, not the + * DB instances for that DB cluster. You must invoke the + * CreateDBInstance action to create DB instances for the restored DB + * cluster, specifying the identifier of the restored DB cluster in + * DBClusterIdentifier. You can create DB instances only after the + * RestoreDBClusterFromS3 action has completed and the DB cluster is + * available.

    For more information on Amazon Aurora, see + * What Is Amazon Aurora? in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    */ @@ -5549,8 +5558,17 @@ namespace Aws * be created using the Percona XtraBackup utility as described in * Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora - * User Guide.

    This action only applies to Aurora DB - * clusters.

    See Also:

    .

    This action only restores the DB cluster, not the + * DB instances for that DB cluster. You must invoke the + * CreateDBInstance action to create DB instances for the restored DB + * cluster, specifying the identifier of the restored DB cluster in + * DBClusterIdentifier. You can create DB instances only after the + * RestoreDBClusterFromS3 action has completed and the DB cluster is + * available.

    For more information on Amazon Aurora, see + * What Is Amazon Aurora? in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    * @@ -5564,8 +5582,17 @@ namespace Aws * be created using the Percona XtraBackup utility as described in * Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora - * User Guide.

    This action only applies to Aurora DB - * clusters.

    See Also:

    .

    This action only restores the DB cluster, not the + * DB instances for that DB cluster. You must invoke the + * CreateDBInstance action to create DB instances for the restored DB + * cluster, specifying the identifier of the restored DB cluster in + * DBClusterIdentifier. You can create DB instances only after the + * RestoreDBClusterFromS3 action has completed and the DB cluster is + * available.

    For more information on Amazon Aurora, see + * What Is Amazon Aurora? in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    * @@ -5587,8 +5614,9 @@ namespace Aws * cluster is available.

    For more information on Amazon Aurora, see * - * What Is Amazon Aurora? in the Amazon Aurora User Guide. - *

    See Also:

    in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    */ @@ -5608,8 +5636,9 @@ namespace Aws * cluster is available.

    For more information on Amazon Aurora, see * - * What Is Amazon Aurora? in the Amazon Aurora User Guide. - *

    See Also:

    in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    * @@ -5631,8 +5660,9 @@ namespace Aws * cluster is available.

    For more information on Amazon Aurora, see * - * What Is Amazon Aurora? in the Amazon Aurora User Guide. - *

    See Also:

    in the Amazon Aurora User Guide.

    + *

    This action only applies to Aurora DB clusters.

    See + * Also:

    AWS * API Reference

    * diff --git a/aws-cpp-sdk-rds/include/aws/rds/model/DescribeOrderableDBInstanceOptionsRequest.h b/aws-cpp-sdk-rds/include/aws/rds/model/DescribeOrderableDBInstanceOptionsRequest.h index afd4d57a856..7b536376509 100644 --- a/aws-cpp-sdk-rds/include/aws/rds/model/DescribeOrderableDBInstanceOptionsRequest.h +++ b/aws-cpp-sdk-rds/include/aws/rds/model/DescribeOrderableDBInstanceOptionsRequest.h @@ -239,6 +239,71 @@ namespace Model inline DescribeOrderableDBInstanceOptionsRequest& WithLicenseModel(const char* value) { SetLicenseModel(value); return *this;} + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline const Aws::String& GetAvailabilityZoneGroup() const{ return m_availabilityZoneGroup; } + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline bool AvailabilityZoneGroupHasBeenSet() const { return m_availabilityZoneGroupHasBeenSet; } + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline void SetAvailabilityZoneGroup(const Aws::String& value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup = value; } + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline void SetAvailabilityZoneGroup(Aws::String&& value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup = std::move(value); } + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline void SetAvailabilityZoneGroup(const char* value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup.assign(value); } + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline DescribeOrderableDBInstanceOptionsRequest& WithAvailabilityZoneGroup(const Aws::String& value) { SetAvailabilityZoneGroup(value); return *this;} + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline DescribeOrderableDBInstanceOptionsRequest& WithAvailabilityZoneGroup(Aws::String&& value) { SetAvailabilityZoneGroup(std::move(value)); return *this;} + + /** + *

    The Availability Zone group associated with a Local Zone. Specify this + * parameter to retrieve available offerings for the Local Zones in the group.

    + *

    Omit this parameter to show the available offerings in the specified AWS + * Region.

    + */ + inline DescribeOrderableDBInstanceOptionsRequest& WithAvailabilityZoneGroup(const char* value) { SetAvailabilityZoneGroup(value); return *this;} + + /** *

    A value that indicates whether to show only VPC or non-VPC offerings.

    */ @@ -416,6 +481,9 @@ namespace Model Aws::String m_licenseModel; bool m_licenseModelHasBeenSet; + Aws::String m_availabilityZoneGroup; + bool m_availabilityZoneGroupHasBeenSet; + bool m_vpc; bool m_vpcHasBeenSet; diff --git a/aws-cpp-sdk-rds/include/aws/rds/model/OrderableDBInstanceOption.h b/aws-cpp-sdk-rds/include/aws/rds/model/OrderableDBInstanceOption.h index 739614e6233..6b76c41e8fb 100644 --- a/aws-cpp-sdk-rds/include/aws/rds/model/OrderableDBInstanceOption.h +++ b/aws-cpp-sdk-rds/include/aws/rds/model/OrderableDBInstanceOption.h @@ -219,6 +219,47 @@ namespace Model inline OrderableDBInstanceOption& WithLicenseModel(const char* value) { SetLicenseModel(value); return *this;} + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline const Aws::String& GetAvailabilityZoneGroup() const{ return m_availabilityZoneGroup; } + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline bool AvailabilityZoneGroupHasBeenSet() const { return m_availabilityZoneGroupHasBeenSet; } + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline void SetAvailabilityZoneGroup(const Aws::String& value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup = value; } + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline void SetAvailabilityZoneGroup(Aws::String&& value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup = std::move(value); } + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline void SetAvailabilityZoneGroup(const char* value) { m_availabilityZoneGroupHasBeenSet = true; m_availabilityZoneGroup.assign(value); } + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline OrderableDBInstanceOption& WithAvailabilityZoneGroup(const Aws::String& value) { SetAvailabilityZoneGroup(value); return *this;} + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline OrderableDBInstanceOption& WithAvailabilityZoneGroup(Aws::String&& value) { SetAvailabilityZoneGroup(std::move(value)); return *this;} + + /** + *

    The Availability Zone group for a DB instance.

    + */ + inline OrderableDBInstanceOption& WithAvailabilityZoneGroup(const char* value) { SetAvailabilityZoneGroup(value); return *this;} + + /** *

    A list of Availability Zones for a DB instance.

    */ @@ -722,26 +763,26 @@ namespace Model /** - *

    Whether or not Amazon RDS can automatically scale storage for DB instances - * that use the specified instance class.

    + *

    Whether Amazon RDS can automatically scale storage for DB instances that use + * the specified DB instance class.

    */ inline bool GetSupportsStorageAutoscaling() const{ return m_supportsStorageAutoscaling; } /** - *

    Whether or not Amazon RDS can automatically scale storage for DB instances - * that use the specified instance class.

    + *

    Whether Amazon RDS can automatically scale storage for DB instances that use + * the specified DB instance class.

    */ inline bool SupportsStorageAutoscalingHasBeenSet() const { return m_supportsStorageAutoscalingHasBeenSet; } /** - *

    Whether or not Amazon RDS can automatically scale storage for DB instances - * that use the specified instance class.

    + *

    Whether Amazon RDS can automatically scale storage for DB instances that use + * the specified DB instance class.

    */ inline void SetSupportsStorageAutoscaling(bool value) { m_supportsStorageAutoscalingHasBeenSet = true; m_supportsStorageAutoscaling = value; } /** - *

    Whether or not Amazon RDS can automatically scale storage for DB instances - * that use the specified instance class.

    + *

    Whether Amazon RDS can automatically scale storage for DB instances that use + * the specified DB instance class.

    */ inline OrderableDBInstanceOption& WithSupportsStorageAutoscaling(bool value) { SetSupportsStorageAutoscaling(value); return *this;} @@ -780,6 +821,9 @@ namespace Model Aws::String m_licenseModel; bool m_licenseModelHasBeenSet; + Aws::String m_availabilityZoneGroup; + bool m_availabilityZoneGroupHasBeenSet; + Aws::Vector m_availabilityZones; bool m_availabilityZonesHasBeenSet; diff --git a/aws-cpp-sdk-rds/source/model/DescribeOrderableDBInstanceOptionsRequest.cpp b/aws-cpp-sdk-rds/source/model/DescribeOrderableDBInstanceOptionsRequest.cpp index f492cca4cfd..e65a307ea7d 100644 --- a/aws-cpp-sdk-rds/source/model/DescribeOrderableDBInstanceOptionsRequest.cpp +++ b/aws-cpp-sdk-rds/source/model/DescribeOrderableDBInstanceOptionsRequest.cpp @@ -25,6 +25,7 @@ DescribeOrderableDBInstanceOptionsRequest::DescribeOrderableDBInstanceOptionsReq m_engineVersionHasBeenSet(false), m_dBInstanceClassHasBeenSet(false), m_licenseModelHasBeenSet(false), + m_availabilityZoneGroupHasBeenSet(false), m_vpc(false), m_vpcHasBeenSet(false), m_filtersHasBeenSet(false), @@ -58,6 +59,11 @@ Aws::String DescribeOrderableDBInstanceOptionsRequest::SerializePayload() const ss << "LicenseModel=" << StringUtils::URLEncode(m_licenseModel.c_str()) << "&"; } + if(m_availabilityZoneGroupHasBeenSet) + { + ss << "AvailabilityZoneGroup=" << StringUtils::URLEncode(m_availabilityZoneGroup.c_str()) << "&"; + } + if(m_vpcHasBeenSet) { ss << "Vpc=" << std::boolalpha << m_vpc << "&"; diff --git a/aws-cpp-sdk-rds/source/model/OrderableDBInstanceOption.cpp b/aws-cpp-sdk-rds/source/model/OrderableDBInstanceOption.cpp index 10c026d3344..3522af2ad82 100644 --- a/aws-cpp-sdk-rds/source/model/OrderableDBInstanceOption.cpp +++ b/aws-cpp-sdk-rds/source/model/OrderableDBInstanceOption.cpp @@ -35,6 +35,7 @@ OrderableDBInstanceOption::OrderableDBInstanceOption() : m_engineVersionHasBeenSet(false), m_dBInstanceClassHasBeenSet(false), m_licenseModelHasBeenSet(false), + m_availabilityZoneGroupHasBeenSet(false), m_availabilityZonesHasBeenSet(false), m_multiAZCapable(false), m_multiAZCapableHasBeenSet(false), @@ -79,6 +80,7 @@ OrderableDBInstanceOption::OrderableDBInstanceOption(const XmlNode& xmlNode) : m_engineVersionHasBeenSet(false), m_dBInstanceClassHasBeenSet(false), m_licenseModelHasBeenSet(false), + m_availabilityZoneGroupHasBeenSet(false), m_availabilityZonesHasBeenSet(false), m_multiAZCapable(false), m_multiAZCapableHasBeenSet(false), @@ -149,6 +151,12 @@ OrderableDBInstanceOption& OrderableDBInstanceOption::operator =(const XmlNode& m_licenseModel = Aws::Utils::Xml::DecodeEscapedXmlText(licenseModelNode.GetText()); m_licenseModelHasBeenSet = true; } + XmlNode availabilityZoneGroupNode = resultNode.FirstChild("AvailabilityZoneGroup"); + if(!availabilityZoneGroupNode.IsNull()) + { + m_availabilityZoneGroup = Aws::Utils::Xml::DecodeEscapedXmlText(availabilityZoneGroupNode.GetText()); + m_availabilityZoneGroupHasBeenSet = true; + } XmlNode availabilityZonesNode = resultNode.FirstChild("AvailabilityZones"); if(!availabilityZonesNode.IsNull()) { @@ -314,6 +322,11 @@ void OrderableDBInstanceOption::OutputToStream(Aws::OStream& oStream, const char oStream << location << index << locationValue << ".LicenseModel=" << StringUtils::URLEncode(m_licenseModel.c_str()) << "&"; } + if(m_availabilityZoneGroupHasBeenSet) + { + oStream << location << index << locationValue << ".AvailabilityZoneGroup=" << StringUtils::URLEncode(m_availabilityZoneGroup.c_str()) << "&"; + } + if(m_availabilityZonesHasBeenSet) { unsigned availabilityZonesIdx = 1; @@ -450,6 +463,10 @@ void OrderableDBInstanceOption::OutputToStream(Aws::OStream& oStream, const char { oStream << location << ".LicenseModel=" << StringUtils::URLEncode(m_licenseModel.c_str()) << "&"; } + if(m_availabilityZoneGroupHasBeenSet) + { + oStream << location << ".AvailabilityZoneGroup=" << StringUtils::URLEncode(m_availabilityZoneGroup.c_str()) << "&"; + } if(m_availabilityZonesHasBeenSet) { unsigned availabilityZonesIdx = 1; diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/StorageGatewayClient.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/StorageGatewayClient.h index 14d9ff262b5..c725146b3d6 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/StorageGatewayClient.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/StorageGatewayClient.h @@ -38,6 +38,7 @@ #include #include #include +#include #include #include #include @@ -67,6 +68,7 @@ #include #include #include +#include #include #include #include @@ -86,6 +88,7 @@ #include #include #include +#include #include #include #include @@ -152,6 +155,7 @@ namespace Model class CreateStorediSCSIVolumeRequest; class CreateTapeWithBarcodeRequest; class CreateTapesRequest; + class DeleteAutomaticTapeCreationPolicyRequest; class DeleteBandwidthRateLimitRequest; class DeleteChapCredentialsRequest; class DeleteFileShareRequest; @@ -181,6 +185,7 @@ namespace Model class DetachVolumeRequest; class DisableGatewayRequest; class JoinDomainRequest; + class ListAutomaticTapeCreationPoliciesRequest; class ListFileSharesRequest; class ListGatewaysRequest; class ListLocalDisksRequest; @@ -200,6 +205,7 @@ namespace Model class ShutdownGatewayRequest; class StartAvailabilityMonitorTestRequest; class StartGatewayRequest; + class UpdateAutomaticTapeCreationPolicyRequest; class UpdateBandwidthRateLimitRequest; class UpdateChapCredentialsRequest; class UpdateGatewayInformationRequest; @@ -228,6 +234,7 @@ namespace Model typedef Aws::Utils::Outcome> CreateStorediSCSIVolumeOutcome; typedef Aws::Utils::Outcome> CreateTapeWithBarcodeOutcome; typedef Aws::Utils::Outcome> CreateTapesOutcome; + typedef Aws::Utils::Outcome> DeleteAutomaticTapeCreationPolicyOutcome; typedef Aws::Utils::Outcome> DeleteBandwidthRateLimitOutcome; typedef Aws::Utils::Outcome> DeleteChapCredentialsOutcome; typedef Aws::Utils::Outcome> DeleteFileShareOutcome; @@ -257,6 +264,7 @@ namespace Model typedef Aws::Utils::Outcome> DetachVolumeOutcome; typedef Aws::Utils::Outcome> DisableGatewayOutcome; typedef Aws::Utils::Outcome> JoinDomainOutcome; + typedef Aws::Utils::Outcome> ListAutomaticTapeCreationPoliciesOutcome; typedef Aws::Utils::Outcome> ListFileSharesOutcome; typedef Aws::Utils::Outcome> ListGatewaysOutcome; typedef Aws::Utils::Outcome> ListLocalDisksOutcome; @@ -276,6 +284,7 @@ namespace Model typedef Aws::Utils::Outcome> ShutdownGatewayOutcome; typedef Aws::Utils::Outcome> StartAvailabilityMonitorTestOutcome; typedef Aws::Utils::Outcome> StartGatewayOutcome; + typedef Aws::Utils::Outcome> UpdateAutomaticTapeCreationPolicyOutcome; typedef Aws::Utils::Outcome> UpdateBandwidthRateLimitOutcome; typedef Aws::Utils::Outcome> UpdateChapCredentialsOutcome; typedef Aws::Utils::Outcome> UpdateGatewayInformationOutcome; @@ -304,6 +313,7 @@ namespace Model typedef std::future CreateStorediSCSIVolumeOutcomeCallable; typedef std::future CreateTapeWithBarcodeOutcomeCallable; typedef std::future CreateTapesOutcomeCallable; + typedef std::future DeleteAutomaticTapeCreationPolicyOutcomeCallable; typedef std::future DeleteBandwidthRateLimitOutcomeCallable; typedef std::future DeleteChapCredentialsOutcomeCallable; typedef std::future DeleteFileShareOutcomeCallable; @@ -333,6 +343,7 @@ namespace Model typedef std::future DetachVolumeOutcomeCallable; typedef std::future DisableGatewayOutcomeCallable; typedef std::future JoinDomainOutcomeCallable; + typedef std::future ListAutomaticTapeCreationPoliciesOutcomeCallable; typedef std::future ListFileSharesOutcomeCallable; typedef std::future ListGatewaysOutcomeCallable; typedef std::future ListLocalDisksOutcomeCallable; @@ -352,6 +363,7 @@ namespace Model typedef std::future ShutdownGatewayOutcomeCallable; typedef std::future StartAvailabilityMonitorTestOutcomeCallable; typedef std::future StartGatewayOutcomeCallable; + typedef std::future UpdateAutomaticTapeCreationPolicyOutcomeCallable; typedef std::future UpdateBandwidthRateLimitOutcomeCallable; typedef std::future UpdateChapCredentialsOutcomeCallable; typedef std::future UpdateGatewayInformationOutcomeCallable; @@ -383,6 +395,7 @@ namespace Model typedef std::function&) > CreateStorediSCSIVolumeResponseReceivedHandler; typedef std::function&) > CreateTapeWithBarcodeResponseReceivedHandler; typedef std::function&) > CreateTapesResponseReceivedHandler; + typedef std::function&) > DeleteAutomaticTapeCreationPolicyResponseReceivedHandler; typedef std::function&) > DeleteBandwidthRateLimitResponseReceivedHandler; typedef std::function&) > DeleteChapCredentialsResponseReceivedHandler; typedef std::function&) > DeleteFileShareResponseReceivedHandler; @@ -412,6 +425,7 @@ namespace Model typedef std::function&) > DetachVolumeResponseReceivedHandler; typedef std::function&) > DisableGatewayResponseReceivedHandler; typedef std::function&) > JoinDomainResponseReceivedHandler; + typedef std::function&) > ListAutomaticTapeCreationPoliciesResponseReceivedHandler; typedef std::function&) > ListFileSharesResponseReceivedHandler; typedef std::function&) > ListGatewaysResponseReceivedHandler; typedef std::function&) > ListLocalDisksResponseReceivedHandler; @@ -431,6 +445,7 @@ namespace Model typedef std::function&) > ShutdownGatewayResponseReceivedHandler; typedef std::function&) > StartAvailabilityMonitorTestResponseReceivedHandler; typedef std::function&) > StartGatewayResponseReceivedHandler; + typedef std::function&) > UpdateAutomaticTapeCreationPolicyResponseReceivedHandler; typedef std::function&) > UpdateBandwidthRateLimitResponseReceivedHandler; typedef std::function&) > UpdateChapCredentialsResponseReceivedHandler; typedef std::function&) > UpdateGatewayInformationResponseReceivedHandler; @@ -447,7 +462,7 @@ namespace Model * service that connects an on-premises software appliance with cloud-based storage * to provide seamless and secure integration between an organization's on-premises * IT environment and the AWS storage infrastructure. The service enables you to - * securely upload data to the AWS cloud for cost effective backup and rapid + * securely upload data to the AWS Cloud for cost effective backup and rapid * disaster recovery.

    Use the following links to get started using the * AWS Storage Gateway Service API Reference:

    • AWS @@ -745,8 +760,9 @@ namespace Model *

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is * archived in the S3 storage class that is associated with the pool. When you use * your backup application to eject the tape, the tape is archived directly into - * the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

      - *

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See Also:

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See + * Also:

      AWS * API Reference

      */ @@ -756,8 +772,9 @@ namespace Model *

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is * archived in the S3 storage class that is associated with the pool. When you use * your backup application to eject the tape, the tape is archived directly into - * the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

      - *

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See Also:

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See + * Also:

      AWS * API Reference

      * @@ -769,8 +786,9 @@ namespace Model *

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is * archived in the S3 storage class that is associated with the pool. When you use * your backup application to eject the tape, the tape is archived directly into - * the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

      - *

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See Also:

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      See + * Also:

      AWS * API Reference

      * @@ -947,10 +965,10 @@ namespace Model /** *

      Creates a Network File System (NFS) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. + * S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. * This operation is only supported for file gateways.

      File * gateway requires AWS Security Token Service (AWS STS) to be activated to enable - * you create a file share. Make sure AWS STS is activated in the AWS Region you + * you to create a file share. Make sure AWS STS is activated in the AWS Region you * are creating your file gateway in. If AWS STS is not activated in the AWS * Region, activate it. For information about how to activate AWS STS, see * Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and @@ -965,10 +983,10 @@ namespace Model /** *

      Creates a Network File System (NFS) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. + * S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. * This operation is only supported for file gateways.

      File * gateway requires AWS Security Token Service (AWS STS) to be activated to enable - * you create a file share. Make sure AWS STS is activated in the AWS Region you + * you to create a file share. Make sure AWS STS is activated in the AWS Region you * are creating your file gateway in. If AWS STS is not activated in the AWS * Region, activate it. For information about how to activate AWS STS, see * Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and @@ -985,10 +1003,10 @@ namespace Model /** *

      Creates a Network File System (NFS) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. + * S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. * This operation is only supported for file gateways.

      File * gateway requires AWS Security Token Service (AWS STS) to be activated to enable - * you create a file share. Make sure AWS STS is activated in the AWS Region you + * you to create a file share. Make sure AWS STS is activated in the AWS Region you * are creating your file gateway in. If AWS STS is not activated in the AWS * Region, activate it. For information about how to activate AWS STS, see * Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and @@ -1005,12 +1023,13 @@ namespace Model /** *

      Creates a Server Message Block (SMB) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This - * operation is only supported for file gateways.

      File gateways - * require AWS Security Token Service (AWS STS) to be activated to enable you to - * create a file share. Make sure that AWS STS is activated in the AWS Region you - * are creating your file gateway in. If AWS STS is not activated in this AWS - * Region, activate it. For information about how to activate AWS STS, see

      File + * gateways require AWS Security Token Service (AWS STS) to be activated to enable + * you to create a file share. Make sure that AWS STS is activated in the AWS + * Region you are creating your file gateway in. If AWS STS is not activated in + * this AWS Region, activate it. For information about how to activate AWS STS, see + * Activating * and Deactivating AWS STS in an AWS Region in the AWS Identity and Access * Management User Guide.

      File gateways don't support creating hard or @@ -1023,12 +1042,13 @@ namespace Model /** *

      Creates a Server Message Block (SMB) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This - * operation is only supported for file gateways.

      File gateways - * require AWS Security Token Service (AWS STS) to be activated to enable you to - * create a file share. Make sure that AWS STS is activated in the AWS Region you - * are creating your file gateway in. If AWS STS is not activated in this AWS - * Region, activate it. For information about how to activate AWS STS, see

      File + * gateways require AWS Security Token Service (AWS STS) to be activated to enable + * you to create a file share. Make sure that AWS STS is activated in the AWS + * Region you are creating your file gateway in. If AWS STS is not activated in + * this AWS Region, activate it. For information about how to activate AWS STS, see + * Activating * and Deactivating AWS STS in an AWS Region in the AWS Identity and Access * Management User Guide.

      File gateways don't support creating hard or @@ -1043,12 +1063,13 @@ namespace Model /** *

      Creates a Server Message Block (SMB) file share on an existing file gateway. * In Storage Gateway, a file share is a file system mount point backed by Amazon - * S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This - * operation is only supported for file gateways.

      File gateways - * require AWS Security Token Service (AWS STS) to be activated to enable you to - * create a file share. Make sure that AWS STS is activated in the AWS Region you - * are creating your file gateway in. If AWS STS is not activated in this AWS - * Region, activate it. For information about how to activate AWS STS, see

      File + * gateways require AWS Security Token Service (AWS STS) to be activated to enable + * you to create a file share. Make sure that AWS STS is activated in the AWS + * Region you are creating your file gateway in. If AWS STS is not activated in + * this AWS Region, activate it. For information about how to activate AWS STS, see + * Activating * and Deactivating AWS STS in an AWS Region in the AWS Identity and Access * Management User Guide.

      File gateways don't support creating hard or @@ -1063,10 +1084,11 @@ namespace Model /** *

      Initiates a snapshot of a volume.

      AWS Storage Gateway provides the * ability to back up point-in-time snapshots of your data to Amazon Simple Storage - * (S3) for durable off-site recovery, as well as import the data to an Amazon - * Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can - * take snapshots of your gateway volume on a scheduled or ad hoc basis. This API - * enables you to take ad-hoc snapshot. For more information, see Editing * a Snapshot Schedule.

      In the CreateSnapshot request you identify the * volume by providing its Amazon Resource Name (ARN). You must also provide @@ -1092,10 +1114,11 @@ namespace Model /** *

      Initiates a snapshot of a volume.

      AWS Storage Gateway provides the * ability to back up point-in-time snapshots of your data to Amazon Simple Storage - * (S3) for durable off-site recovery, as well as import the data to an Amazon - * Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can - * take snapshots of your gateway volume on a scheduled or ad hoc basis. This API - * enables you to take ad-hoc snapshot. For more information, see Editing * a Snapshot Schedule.

      In the CreateSnapshot request you identify the * volume by providing its Amazon Resource Name (ARN). You must also provide @@ -1123,10 +1146,11 @@ namespace Model /** *

      Initiates a snapshot of a volume.

      AWS Storage Gateway provides the * ability to back up point-in-time snapshots of your data to Amazon Simple Storage - * (S3) for durable off-site recovery, as well as import the data to an Amazon - * Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can - * take snapshots of your gateway volume on a scheduled or ad hoc basis. This API - * enables you to take ad-hoc snapshot. For more information, see Editing * a Snapshot Schedule.

      In the CreateSnapshot request you identify the * volume by providing its Amazon Resource Name (ARN). You must also provide @@ -1269,10 +1293,10 @@ namespace Model /** *

      Creates a virtual tape by using your own barcode. You write data to the - * virtual tape and then archive the tape. A barcode is unique and can not be - * reused if it has already been used on a tape . This applies to barcodes used on - * deleted tapes. This operation is only supported in the tape gateway type.

      - *

      Cache storage must be allocated to the gateway before you can create a + * virtual tape and then archive the tape. A barcode is unique and cannot be reused + * if it has already been used on a tape. This applies to barcodes used on deleted + * tapes. This operation is only supported in the tape gateway type.

      + *

      Cache storage must be allocated to the gateway before you can create a * virtual tape. Use the AddCache operation to add cache storage to a * gateway.

      See Also:

      AWS @@ -1282,10 +1306,10 @@ namespace Model /** *

      Creates a virtual tape by using your own barcode. You write data to the - * virtual tape and then archive the tape. A barcode is unique and can not be - * reused if it has already been used on a tape . This applies to barcodes used on - * deleted tapes. This operation is only supported in the tape gateway type.

      - *

      Cache storage must be allocated to the gateway before you can create a + * virtual tape and then archive the tape. A barcode is unique and cannot be reused + * if it has already been used on a tape. This applies to barcodes used on deleted + * tapes. This operation is only supported in the tape gateway type.

      + *

      Cache storage must be allocated to the gateway before you can create a * virtual tape. Use the AddCache operation to add cache storage to a * gateway.

      See Also:

      AWS @@ -1297,10 +1321,10 @@ namespace Model /** *

      Creates a virtual tape by using your own barcode. You write data to the - * virtual tape and then archive the tape. A barcode is unique and can not be - * reused if it has already been used on a tape . This applies to barcodes used on - * deleted tapes. This operation is only supported in the tape gateway type.

      - *

      Cache storage must be allocated to the gateway before you can create a + * virtual tape and then archive the tape. A barcode is unique and cannot be reused + * if it has already been used on a tape. This applies to barcodes used on deleted + * tapes. This operation is only supported in the tape gateway type.

      + *

      Cache storage must be allocated to the gateway before you can create a * virtual tape. Use the AddCache operation to add cache storage to a * gateway.

      See Also:

      AWS @@ -1347,6 +1371,40 @@ namespace Model */ virtual void CreateTapesAsync(const Model::CreateTapesRequest& request, const CreateTapesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** + *

      Deletes the automatic tape creation policy of a gateway. If you delete this + * policy, new virtual tapes must be created manually. Use the Amazon Resource Name + * (ARN) of the gateway in your request to remove the policy.

      See + * Also:

      AWS + * API Reference

      + */ + virtual Model::DeleteAutomaticTapeCreationPolicyOutcome DeleteAutomaticTapeCreationPolicy(const Model::DeleteAutomaticTapeCreationPolicyRequest& request) const; + + /** + *

      Deletes the automatic tape creation policy of a gateway. If you delete this + * policy, new virtual tapes must be created manually. Use the Amazon Resource Name + * (ARN) of the gateway in your request to remove the policy.

      See + * Also:

      AWS + * API Reference

      + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::DeleteAutomaticTapeCreationPolicyOutcomeCallable DeleteAutomaticTapeCreationPolicyCallable(const Model::DeleteAutomaticTapeCreationPolicyRequest& request) const; + + /** + *

      Deletes the automatic tape creation policy of a gateway. If you delete this + * policy, new virtual tapes must be created manually. Use the Amazon Resource Name + * (ARN) of the gateway in your request to remove the policy.

      See + * Also:

      AWS + * API Reference

      + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void DeleteAutomaticTapeCreationPolicyAsync(const Model::DeleteAutomaticTapeCreationPolicyRequest& request, const DeleteAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** *

      Deletes the bandwidth rate limits of a gateway. You can delete either the * upload and download bandwidth rate limit, or you can delete both. If you delete @@ -1521,8 +1579,11 @@ namespace Model * with Snapshots. In the DeleteSnapshotSchedule request, you * identify the volume by providing its Amazon Resource Name (ARN). This operation * is only supported in stored and cached volume gateway types.

      To - * list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic - * Compute Cloud API Reference.

      See Also:

      DescribeSnapshots + * in the Amazon Elastic Compute Cloud API Reference.

      See + * Also:

      AWS * API Reference

      */ @@ -1536,8 +1597,11 @@ namespace Model * with Snapshots. In the DeleteSnapshotSchedule request, you * identify the volume by providing its Amazon Resource Name (ARN). This operation * is only supported in stored and cached volume gateway types.

      To - * list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic - * Compute Cloud API Reference.

      See Also:

      DescribeSnapshots + * in the Amazon Elastic Compute Cloud API Reference.

      See + * Also:

      AWS * API Reference

      * @@ -1553,8 +1617,11 @@ namespace Model * with Snapshots. In the DeleteSnapshotSchedule request, you * identify the volume by providing its Amazon Resource Name (ARN). This operation * is only supported in stored and cached volume gateway types.

      To - * list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic - * Compute Cloud API Reference.

      See Also:

      DescribeSnapshots + * in the Amazon Elastic Compute Cloud API Reference.

      See + * Also:

      AWS * API Reference

      * @@ -1767,9 +1834,9 @@ namespace Model /** *

      Returns information about the cache of a gateway. This operation is only - * supported in the cached volume, tape and file gateway types.

      The response - * includes disk IDs that are configured as cache, and it includes the amount of - * cache allocated and used.

      See Also:

      The + * response includes disk IDs that are configured as cache, and it includes the + * amount of cache allocated and used.

      See Also:

      AWS * API Reference

      */ @@ -1777,9 +1844,9 @@ namespace Model /** *

      Returns information about the cache of a gateway. This operation is only - * supported in the cached volume, tape and file gateway types.

      The response - * includes disk IDs that are configured as cache, and it includes the amount of - * cache allocated and used.

      See Also:

      The + * response includes disk IDs that are configured as cache, and it includes the + * amount of cache allocated and used.

      See Also:

      AWS * API Reference

      * @@ -1789,9 +1856,9 @@ namespace Model /** *

      Returns information about the cache of a gateway. This operation is only - * supported in the cached volume, tape and file gateway types.

      The response - * includes disk IDs that are configured as cache, and it includes the amount of - * cache allocated and used.

      See Also:

      The + * response includes disk IDs that are configured as cache, and it includes the + * amount of cache allocated and used.

      See Also:

      AWS * API Reference

      * @@ -1802,9 +1869,9 @@ namespace Model /** *

      Returns a description of the gateway volumes specified in the request. This * operation is only supported in the cached volume gateway types.

      The list - * of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume Amazon - * Resource Name (ARN).

      See Also:

      See Also:

      AWS * API Reference

      */ @@ -1813,9 +1880,9 @@ namespace Model /** *

      Returns a description of the gateway volumes specified in the request. This * operation is only supported in the cached volume gateway types.

      The list - * of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume Amazon - * Resource Name (ARN).

      See Also:

      See Also:

      AWS * API Reference

      * @@ -1826,9 +1893,9 @@ namespace Model /** *

      Returns a description of the gateway volumes specified in the request. This * operation is only supported in the cached volume gateway types.

      The list - * of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume Amazon - * Resource Name (ARN).

      See Also:

      See Also:

      AWS * API Reference

      * @@ -2065,7 +2132,7 @@ namespace Model /** *

      Returns the description of the gateway volumes specified in the request. The * list of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume ARNs. This + * AWS Storage Gateway returns volume information sorted by volume ARNs. This * operation is only supported in stored volume gateway type.

      See * Also:

      AWS @@ -2076,7 +2143,7 @@ namespace Model /** *

      Returns the description of the gateway volumes specified in the request. The * list of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume ARNs. This + * AWS Storage Gateway returns volume information sorted by volume ARNs. This * operation is only supported in stored volume gateway type.

      See * Also:

      AWS @@ -2089,7 +2156,7 @@ namespace Model /** *

      Returns the description of the gateway volumes specified in the request. The * list of gateway volumes in the request must be from one gateway. In the response - * Amazon Storage Gateway returns volume information sorted by volume ARNs. This + * AWS Storage Gateway returns volume information sorted by volume ARNs. This * operation is only supported in stored volume gateway type.

      See * Also:

      AWS @@ -2372,7 +2439,7 @@ namespace Model * example, if your gateway VM is damaged, you can disable the gateway so you can * recover virtual tapes.

      Use this operation for a tape gateway that is not * reachable or not functioning. This operation is only supported in the tape - * gateway type.

      Once a gateway is disabled it cannot be + * gateway type.

      After a gateway is disabled, it cannot be * enabled.

      See Also:

      AWS * API Reference

      @@ -2384,7 +2451,7 @@ namespace Model * example, if your gateway VM is damaged, you can disable the gateway so you can * recover virtual tapes.

      Use this operation for a tape gateway that is not * reachable or not functioning. This operation is only supported in the tape - * gateway type.

      Once a gateway is disabled it cannot be + * gateway type.

      After a gateway is disabled, it cannot be * enabled.

      See Also:

      AWS * API Reference

      @@ -2398,7 +2465,7 @@ namespace Model * example, if your gateway VM is damaged, you can disable the gateway so you can * recover virtual tapes.

      Use this operation for a tape gateway that is not * reachable or not functioning. This operation is only supported in the tape - * gateway type.

      Once a gateway is disabled it cannot be + * gateway type.

      After a gateway is disabled, it cannot be * enabled.

      See Also:

      AWS * API Reference

      @@ -2438,6 +2505,40 @@ namespace Model */ virtual void JoinDomainAsync(const Model::JoinDomainRequest& request, const JoinDomainResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** + *

      Lists the automatic tape creation policies for a gateway. If there are no + * automatic tape creation policies for the gateway, it returns an empty list.

      + *

      This operation is only supported for tape gateways.

      See Also:

      + * AWS + * API Reference

      + */ + virtual Model::ListAutomaticTapeCreationPoliciesOutcome ListAutomaticTapeCreationPolicies(const Model::ListAutomaticTapeCreationPoliciesRequest& request) const; + + /** + *

      Lists the automatic tape creation policies for a gateway. If there are no + * automatic tape creation policies for the gateway, it returns an empty list.

      + *

      This operation is only supported for tape gateways.

      See Also:

      + * AWS + * API Reference

      + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::ListAutomaticTapeCreationPoliciesOutcomeCallable ListAutomaticTapeCreationPoliciesCallable(const Model::ListAutomaticTapeCreationPoliciesRequest& request) const; + + /** + *

      Lists the automatic tape creation policies for a gateway. If there are no + * automatic tape creation policies for the gateway, it returns an empty list.

      + *

      This operation is only supported for tape gateways.

      See Also:

      + * AWS + * API Reference

      + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void ListAutomaticTapeCreationPoliciesAsync(const Model::ListAutomaticTapeCreationPoliciesRequest& request, const ListAutomaticTapeCreationPoliciesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** *

      Gets a list of the file shares for a specific file gateway, or the list of * file shares that belong to the calling user account. This operation is only @@ -2960,12 +3061,12 @@ namespace Model virtual void RemoveTagsFromResourceAsync(const Model::RemoveTagsFromResourceRequest& request, const RemoveTagsFromResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** - *

      Resets all cache disks that have encountered a error and makes the disks - * available for reconfiguration as cache storage. If your cache disk encounters a + *

      Resets all cache disks that have encountered an error and makes the disks + * available for reconfiguration as cache storage. If your cache disk encounters an * error, the gateway prevents read and write operations on virtual tapes in the * gateway. For example, an error can occur when a disk is corrupted or removed * from the gateway. When a cache is reset, the gateway loses its cache storage. At - * this point you can reconfigure the disks as cache disks. This operation is only + * this point, you can reconfigure the disks as cache disks. This operation is only * supported in the cached volume and tape types.

      If the cache * disk you are resetting contains data that has not been uploaded to Amazon S3 * yet, that data can be lost. After you reset cache disks, there will be no @@ -2978,12 +3079,12 @@ namespace Model virtual Model::ResetCacheOutcome ResetCache(const Model::ResetCacheRequest& request) const; /** - *

      Resets all cache disks that have encountered a error and makes the disks - * available for reconfiguration as cache storage. If your cache disk encounters a + *

      Resets all cache disks that have encountered an error and makes the disks + * available for reconfiguration as cache storage. If your cache disk encounters an * error, the gateway prevents read and write operations on virtual tapes in the * gateway. For example, an error can occur when a disk is corrupted or removed * from the gateway. When a cache is reset, the gateway loses its cache storage. At - * this point you can reconfigure the disks as cache disks. This operation is only + * this point, you can reconfigure the disks as cache disks. This operation is only * supported in the cached volume and tape types.

      If the cache * disk you are resetting contains data that has not been uploaded to Amazon S3 * yet, that data can be lost. After you reset cache disks, there will be no @@ -2998,12 +3099,12 @@ namespace Model virtual Model::ResetCacheOutcomeCallable ResetCacheCallable(const Model::ResetCacheRequest& request) const; /** - *

      Resets all cache disks that have encountered a error and makes the disks - * available for reconfiguration as cache storage. If your cache disk encounters a + *

      Resets all cache disks that have encountered an error and makes the disks + * available for reconfiguration as cache storage. If your cache disk encounters an * error, the gateway prevents read and write operations on virtual tapes in the * gateway. For example, an error can occur when a disk is corrupted or removed * from the gateway. When a cache is reset, the gateway loses its cache storage. At - * this point you can reconfigure the disks as cache disks. This operation is only + * this point, you can reconfigure the disks as cache disks. This operation is only * supported in the cached volume and tape types.

      If the cache * disk you are resetting contains data that has not been uploaded to Amazon S3 * yet, that data can be lost. After you reset cache disks, there will be no @@ -3185,16 +3286,16 @@ namespace Model * the VM, it is recommended that you first shut down the gateway component in the * VM to avoid unpredictable conditions.

      After the gateway is * shutdown, you cannot call any other API except StartGateway, - * DescribeGatewayInformation, and ListGateways. For more - * information, see ActivateGateway. Your applications cannot read from or - * write to the gateway's storage volumes, and there are no snapshots taken.

      - *

      When you make a shutdown request, you will get a 200 OK - * success response immediately. However, it might take some time for the gateway - * to shut down. You can call the DescribeGatewayInformation API to check - * the status. For more information, see ActivateGateway.

      If - * do not intend to use the gateway again, you must delete the gateway (using - * DeleteGateway) to no longer pay software charges associated with the - * gateway.

      See Also:

      DescribeGatewayInformation and ListGateways. For more information, + * see ActivateGateway. Your applications cannot read from or write to the + * gateway's storage volumes, and there are no snapshots taken.

      When + * you make a shutdown request, you will get a 200 OK success response + * immediately. However, it might take some time for the gateway to shut down. You + * can call the DescribeGatewayInformation API to check the status. For more + * information, see ActivateGateway.

      If do not intend to use + * the gateway again, you must delete the gateway (using DeleteGateway) to + * no longer pay software charges associated with the gateway.

      See + * Also:

      AWS * API Reference

      */ @@ -3208,16 +3309,16 @@ namespace Model * the VM, it is recommended that you first shut down the gateway component in the * VM to avoid unpredictable conditions.

      After the gateway is * shutdown, you cannot call any other API except StartGateway, - * DescribeGatewayInformation, and ListGateways. For more - * information, see ActivateGateway. Your applications cannot read from or - * write to the gateway's storage volumes, and there are no snapshots taken.

      - *

      When you make a shutdown request, you will get a 200 OK - * success response immediately. However, it might take some time for the gateway - * to shut down. You can call the DescribeGatewayInformation API to check - * the status. For more information, see ActivateGateway.

      If - * do not intend to use the gateway again, you must delete the gateway (using - * DeleteGateway) to no longer pay software charges associated with the - * gateway.

      See Also:

      DescribeGatewayInformation and ListGateways. For more information, + * see ActivateGateway. Your applications cannot read from or write to the + * gateway's storage volumes, and there are no snapshots taken.

      When + * you make a shutdown request, you will get a 200 OK success response + * immediately. However, it might take some time for the gateway to shut down. You + * can call the DescribeGatewayInformation API to check the status. For more + * information, see ActivateGateway.

      If do not intend to use + * the gateway again, you must delete the gateway (using DeleteGateway) to + * no longer pay software charges associated with the gateway.

      See + * Also:

      AWS * API Reference

      * @@ -3233,16 +3334,16 @@ namespace Model * the VM, it is recommended that you first shut down the gateway component in the * VM to avoid unpredictable conditions.

      After the gateway is * shutdown, you cannot call any other API except StartGateway, - * DescribeGatewayInformation, and ListGateways. For more - * information, see ActivateGateway. Your applications cannot read from or - * write to the gateway's storage volumes, and there are no snapshots taken.

      - *

      When you make a shutdown request, you will get a 200 OK - * success response immediately. However, it might take some time for the gateway - * to shut down. You can call the DescribeGatewayInformation API to check - * the status. For more information, see ActivateGateway.

      If - * do not intend to use the gateway again, you must delete the gateway (using - * DeleteGateway) to no longer pay software charges associated with the - * gateway.

      See Also:

      DescribeGatewayInformation and ListGateways. For more information, + * see ActivateGateway. Your applications cannot read from or write to the + * gateway's storage volumes, and there are no snapshots taken.

      When + * you make a shutdown request, you will get a 200 OK success response + * immediately. However, it might take some time for the gateway to shut down. You + * can call the DescribeGatewayInformation API to check the status. For more + * information, see ActivateGateway.

      If do not intend to use + * the gateway again, you must delete the gateway (using DeleteGateway) to + * no longer pay software charges associated with the gateway.

      See + * Also:

      AWS * API Reference

      * @@ -3345,6 +3446,43 @@ namespace Model */ virtual void StartGatewayAsync(const Model::StartGatewayRequest& request, const StartGatewayResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** + *

      Updates the automatic tape creation policy of a gateway. Use this to update + * the policy with a new set of automatic tape creation rules. This is only + * supported for tape gateways.

      By default, there is no automatic tape + * creation policy.

      A gateway can have only one automatic tape + * creation policy.

      See Also:

      AWS + * API Reference

      + */ + virtual Model::UpdateAutomaticTapeCreationPolicyOutcome UpdateAutomaticTapeCreationPolicy(const Model::UpdateAutomaticTapeCreationPolicyRequest& request) const; + + /** + *

      Updates the automatic tape creation policy of a gateway. Use this to update + * the policy with a new set of automatic tape creation rules. This is only + * supported for tape gateways.

      By default, there is no automatic tape + * creation policy.

      A gateway can have only one automatic tape + * creation policy.

      See Also:

      AWS + * API Reference

      + * + * returns a future to the operation so that it can be executed in parallel to other requests. + */ + virtual Model::UpdateAutomaticTapeCreationPolicyOutcomeCallable UpdateAutomaticTapeCreationPolicyCallable(const Model::UpdateAutomaticTapeCreationPolicyRequest& request) const; + + /** + *

      Updates the automatic tape creation policy of a gateway. Use this to update + * the policy with a new set of automatic tape creation rules. This is only + * supported for tape gateways.

      By default, there is no automatic tape + * creation policy.

      A gateway can have only one automatic tape + * creation policy.

      See Also:

      AWS + * API Reference

      + * + * Queues the request into a thread executor and triggers associated callback when operation has finished. + */ + virtual void UpdateAutomaticTapeCreationPolicyAsync(const Model::UpdateAutomaticTapeCreationPolicyRequest& request, const UpdateAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; + /** *

      Updates the bandwidth rate limits of a gateway. You can update both the * upload and download bandwidth rate limit or specify only one of the two. If you @@ -3820,6 +3958,7 @@ namespace Model void CreateStorediSCSIVolumeAsyncHelper(const Model::CreateStorediSCSIVolumeRequest& request, const CreateStorediSCSIVolumeResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CreateTapeWithBarcodeAsyncHelper(const Model::CreateTapeWithBarcodeRequest& request, const CreateTapeWithBarcodeResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CreateTapesAsyncHelper(const Model::CreateTapesRequest& request, const CreateTapesResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void DeleteAutomaticTapeCreationPolicyAsyncHelper(const Model::DeleteAutomaticTapeCreationPolicyRequest& request, const DeleteAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBandwidthRateLimitAsyncHelper(const Model::DeleteBandwidthRateLimitRequest& request, const DeleteBandwidthRateLimitResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteChapCredentialsAsyncHelper(const Model::DeleteChapCredentialsRequest& request, const DeleteChapCredentialsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteFileShareAsyncHelper(const Model::DeleteFileShareRequest& request, const DeleteFileShareResponseReceivedHandler& handler, const std::shared_ptr& context) const; @@ -3849,6 +3988,7 @@ namespace Model void DetachVolumeAsyncHelper(const Model::DetachVolumeRequest& request, const DetachVolumeResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DisableGatewayAsyncHelper(const Model::DisableGatewayRequest& request, const DisableGatewayResponseReceivedHandler& handler, const std::shared_ptr& context) const; void JoinDomainAsyncHelper(const Model::JoinDomainRequest& request, const JoinDomainResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void ListAutomaticTapeCreationPoliciesAsyncHelper(const Model::ListAutomaticTapeCreationPoliciesRequest& request, const ListAutomaticTapeCreationPoliciesResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListFileSharesAsyncHelper(const Model::ListFileSharesRequest& request, const ListFileSharesResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListGatewaysAsyncHelper(const Model::ListGatewaysRequest& request, const ListGatewaysResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListLocalDisksAsyncHelper(const Model::ListLocalDisksRequest& request, const ListLocalDisksResponseReceivedHandler& handler, const std::shared_ptr& context) const; @@ -3868,6 +4008,7 @@ namespace Model void ShutdownGatewayAsyncHelper(const Model::ShutdownGatewayRequest& request, const ShutdownGatewayResponseReceivedHandler& handler, const std::shared_ptr& context) const; void StartAvailabilityMonitorTestAsyncHelper(const Model::StartAvailabilityMonitorTestRequest& request, const StartAvailabilityMonitorTestResponseReceivedHandler& handler, const std::shared_ptr& context) const; void StartGatewayAsyncHelper(const Model::StartGatewayRequest& request, const StartGatewayResponseReceivedHandler& handler, const std::shared_ptr& context) const; + void UpdateAutomaticTapeCreationPolicyAsyncHelper(const Model::UpdateAutomaticTapeCreationPolicyRequest& request, const UpdateAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void UpdateBandwidthRateLimitAsyncHelper(const Model::UpdateBandwidthRateLimitRequest& request, const UpdateBandwidthRateLimitResponseReceivedHandler& handler, const std::shared_ptr& context) const; void UpdateChapCredentialsAsyncHelper(const Model::UpdateChapCredentialsRequest& request, const UpdateChapCredentialsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void UpdateGatewayInformationAsyncHelper(const Model::UpdateGatewayInformationRequest& request, const UpdateGatewayInformationResponseReceivedHandler& handler, const std::shared_ptr& context) const; diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddCacheRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddCacheRequest.h index 43f5bb5aa2b..0b2e4d3f5f6 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddCacheRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddCacheRequest.h @@ -72,63 +72,63 @@ namespace Model /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline const Aws::Vector& GetDiskIds() const{ return m_diskIds; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline bool DiskIdsHasBeenSet() const { return m_diskIdsHasBeenSet; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(const Aws::Vector& value) { m_diskIdsHasBeenSet = true; m_diskIds = value; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(Aws::Vector&& value) { m_diskIdsHasBeenSet = true; m_diskIds = std::move(value); } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddCacheRequest& WithDiskIds(const Aws::Vector& value) { SetDiskIds(value); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddCacheRequest& WithDiskIds(Aws::Vector&& value) { SetDiskIds(std::move(value)); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddCacheRequest& AddDiskIds(const Aws::String& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddCacheRequest& AddDiskIds(Aws::String&& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(std::move(value)); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddCacheRequest& AddDiskIds(const char* value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddUploadBufferRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddUploadBufferRequest.h index 54b8d66cc18..44e5f4c9469 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddUploadBufferRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddUploadBufferRequest.h @@ -72,63 +72,63 @@ namespace Model /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline const Aws::Vector& GetDiskIds() const{ return m_diskIds; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline bool DiskIdsHasBeenSet() const { return m_diskIdsHasBeenSet; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(const Aws::Vector& value) { m_diskIdsHasBeenSet = true; m_diskIds = value; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(Aws::Vector&& value) { m_diskIdsHasBeenSet = true; m_diskIds = std::move(value); } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddUploadBufferRequest& WithDiskIds(const Aws::Vector& value) { SetDiskIds(value); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddUploadBufferRequest& WithDiskIds(Aws::Vector&& value) { SetDiskIds(std::move(value)); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddUploadBufferRequest& AddDiskIds(const Aws::String& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddUploadBufferRequest& AddDiskIds(Aws::String&& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(std::move(value)); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddUploadBufferRequest& AddDiskIds(const char* value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageRequest.h index 03d4aca58b4..ba9c45a71a1 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageRequest.h @@ -77,63 +77,63 @@ namespace Model /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline const Aws::Vector& GetDiskIds() const{ return m_diskIds; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline bool DiskIdsHasBeenSet() const { return m_diskIdsHasBeenSet; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(const Aws::Vector& value) { m_diskIdsHasBeenSet = true; m_diskIds = value; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(Aws::Vector&& value) { m_diskIdsHasBeenSet = true; m_diskIds = std::move(value); } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddWorkingStorageRequest& WithDiskIds(const Aws::Vector& value) { SetDiskIds(value); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddWorkingStorageRequest& WithDiskIds(Aws::Vector&& value) { SetDiskIds(std::move(value)); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddWorkingStorageRequest& AddDiskIds(const Aws::String& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddWorkingStorageRequest& AddDiskIds(Aws::String&& value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(std::move(value)); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline AddWorkingStorageRequest& AddDiskIds(const char* value) { m_diskIdsHasBeenSet = true; m_diskIds.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageResult.h index 30e7e3e821b..9818012b6cb 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AddWorkingStorageResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway for which working storage was - * configured.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway for + * which working storage was configured.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AssignTapePoolRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AssignTapePoolRequest.h index 402958aab58..19f22d3578a 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AssignTapePoolRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AssignTapePoolRequest.h @@ -97,8 +97,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline const Aws::String& GetPoolId() const{ return m_poolId; } @@ -106,8 +106,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } @@ -115,8 +115,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } @@ -124,8 +124,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } @@ -133,8 +133,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } @@ -142,8 +142,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline AssignTapePoolRequest& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} @@ -151,8 +151,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline AssignTapePoolRequest& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} @@ -160,8 +160,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline AssignTapePoolRequest& WithPoolId(const char* value) { SetPoolId(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationPolicyInfo.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationPolicyInfo.h new file mode 100644 index 00000000000..4710a62e360 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationPolicyInfo.h @@ -0,0 +1,146 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace StorageGateway +{ +namespace Model +{ + + /** + *

      Information about the gateway's automatic tape creation policies, including + * the automatic tape creation rules and the gateway that is using the + * policies.

      See Also:

      AWS + * API Reference

      + */ + class AWS_STORAGEGATEWAY_API AutomaticTapeCreationPolicyInfo + { + public: + AutomaticTapeCreationPolicyInfo(); + AutomaticTapeCreationPolicyInfo(Aws::Utils::Json::JsonView jsonValue); + AutomaticTapeCreationPolicyInfo& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline const Aws::Vector& GetAutomaticTapeCreationRules() const{ return m_automaticTapeCreationRules; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline bool AutomaticTapeCreationRulesHasBeenSet() const { return m_automaticTapeCreationRulesHasBeenSet; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline void SetAutomaticTapeCreationRules(const Aws::Vector& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules = value; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline void SetAutomaticTapeCreationRules(Aws::Vector&& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules = std::move(value); } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline AutomaticTapeCreationPolicyInfo& WithAutomaticTapeCreationRules(const Aws::Vector& value) { SetAutomaticTapeCreationRules(value); return *this;} + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline AutomaticTapeCreationPolicyInfo& WithAutomaticTapeCreationRules(Aws::Vector&& value) { SetAutomaticTapeCreationRules(std::move(value)); return *this;} + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline AutomaticTapeCreationPolicyInfo& AddAutomaticTapeCreationRules(const AutomaticTapeCreationRule& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules.push_back(value); return *this; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. This returns the rules that determine when and how to + * automatically create new tapes.

      + */ + inline AutomaticTapeCreationPolicyInfo& AddAutomaticTapeCreationRules(AutomaticTapeCreationRule&& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules.push_back(std::move(value)); return *this; } + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } + + + inline AutomaticTapeCreationPolicyInfo& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline AutomaticTapeCreationPolicyInfo& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline AutomaticTapeCreationPolicyInfo& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::Vector m_automaticTapeCreationRules; + bool m_automaticTapeCreationRulesHasBeenSet; + + Aws::String m_gatewayARN; + bool m_gatewayARNHasBeenSet; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationRule.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationRule.h new file mode 100644 index 00000000000..248fcd75bf2 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/AutomaticTapeCreationRule.h @@ -0,0 +1,260 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include + +namespace Aws +{ +namespace Utils +{ +namespace Json +{ + class JsonValue; + class JsonView; +} // namespace Json +} // namespace Utils +namespace StorageGateway +{ +namespace Model +{ + + /** + *

      An automatic tape creation policy consists of automatic tape creation rules + * where each rule defines when and how to create new tapes.

      See + * Also:

      AWS + * API Reference

      + */ + class AWS_STORAGEGATEWAY_API AutomaticTapeCreationRule + { + public: + AutomaticTapeCreationRule(); + AutomaticTapeCreationRule(Aws::Utils::Json::JsonView jsonValue); + AutomaticTapeCreationRule& operator=(Aws::Utils::Json::JsonView jsonValue); + Aws::Utils::Json::JsonValue Jsonize() const; + + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline const Aws::String& GetTapeBarcodePrefix() const{ return m_tapeBarcodePrefix; } + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline bool TapeBarcodePrefixHasBeenSet() const { return m_tapeBarcodePrefixHasBeenSet; } + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline void SetTapeBarcodePrefix(const Aws::String& value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix = value; } + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline void SetTapeBarcodePrefix(Aws::String&& value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix = std::move(value); } + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline void SetTapeBarcodePrefix(const char* value) { m_tapeBarcodePrefixHasBeenSet = true; m_tapeBarcodePrefix.assign(value); } + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline AutomaticTapeCreationRule& WithTapeBarcodePrefix(const Aws::String& value) { SetTapeBarcodePrefix(value); return *this;} + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline AutomaticTapeCreationRule& WithTapeBarcodePrefix(Aws::String&& value) { SetTapeBarcodePrefix(std::move(value)); return *this;} + + /** + *

      A prefix that you append to the barcode of the virtual tape that you are + * creating. This prefix makes the barcode unique.

      The prefix must be + * 1-4 characters in length and must be one of the uppercase letters from A to + * Z.

       + */ + inline AutomaticTapeCreationRule& WithTapeBarcodePrefix(const char* value) { SetTapeBarcodePrefix(value); return *this;} + + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline const Aws::String& GetPoolId() const{ return m_poolId; } + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline AutomaticTapeCreationRule& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline AutomaticTapeCreationRule& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} + + /** + *

      The ID of the pool that you want to add your tape to for archiving. The tape + * in this pool is archived in the Amazon S3 storage class that is associated with + * the pool. When you use your backup application to eject the tape, the tape is + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + */ + inline AutomaticTapeCreationRule& WithPoolId(const char* value) { SetPoolId(value); return *this;} + + + /** + *

      The size, in bytes, of the virtual tape capacity.

      + */ + inline long long GetTapeSizeInBytes() const{ return m_tapeSizeInBytes; } + + /** + *

      The size, in bytes, of the virtual tape capacity.

      + */ + inline bool TapeSizeInBytesHasBeenSet() const { return m_tapeSizeInBytesHasBeenSet; } + + /** + *

      The size, in bytes, of the virtual tape capacity.

      + */ + inline void SetTapeSizeInBytes(long long value) { m_tapeSizeInBytesHasBeenSet = true; m_tapeSizeInBytes = value; } + + /** + *

      The size, in bytes, of the virtual tape capacity.

      + */ + inline AutomaticTapeCreationRule& WithTapeSizeInBytes(long long value) { SetTapeSizeInBytes(value); return *this;} + + + /** + *

      The minimum number of available virtual tapes that the gateway maintains at + * all times. If the number of tapes on the gateway goes below this value, the + * gateway creates as many new tapes as are needed to have + * MinimumNumTapes on the gateway.

      + */ + inline int GetMinimumNumTapes() const{ return m_minimumNumTapes; } + + /** + *

      The minimum number of available virtual tapes that the gateway maintains at + * all times. If the number of tapes on the gateway goes below this value, the + * gateway creates as many new tapes as are needed to have + * MinimumNumTapes on the gateway.

      + */ + inline bool MinimumNumTapesHasBeenSet() const { return m_minimumNumTapesHasBeenSet; } + + /** + *

      The minimum number of available virtual tapes that the gateway maintains at + * all times. If the number of tapes on the gateway goes below this value, the + * gateway creates as many new tapes as are needed to have + * MinimumNumTapes on the gateway.

      + */ + inline void SetMinimumNumTapes(int value) { m_minimumNumTapesHasBeenSet = true; m_minimumNumTapes = value; } + + /** + *

      The minimum number of available virtual tapes that the gateway maintains at + * all times. If the number of tapes on the gateway goes below this value, the + * gateway creates as many new tapes as are needed to have + * MinimumNumTapes on the gateway.

      + */ + inline AutomaticTapeCreationRule& WithMinimumNumTapes(int value) { SetMinimumNumTapes(value); return *this;} + + private: + + Aws::String m_tapeBarcodePrefix; + bool m_tapeBarcodePrefixHasBeenSet; + + Aws::String m_poolId; + bool m_poolIdHasBeenSet; + + long long m_tapeSizeInBytes; + bool m_tapeSizeInBytesHasBeenSet; + + int m_minimumNumTapes; + bool m_minimumNumTapesHasBeenSet; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateCachediSCSIVolumeRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateCachediSCSIVolumeRequest.h index db5f4035271..1321540c6d6 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateCachediSCSIVolumeRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateCachediSCSIVolumeRequest.h @@ -442,82 +442,82 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateCachediSCSIVolumeRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateCachediSCSIVolumeRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateCachediSCSIVolumeRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateCachediSCSIVolumeRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateNFSFileShareRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateNFSFileShareRequest.h index 40ec2b6bdd3..ec958ff72da 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateNFSFileShareRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateNFSFileShareRequest.h @@ -181,74 +181,74 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateNFSFileShareRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateNFSFileShareRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateNFSFileShareRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateNFSFileShareRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateSMBFileShareRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateSMBFileShareRequest.h index f4270420c33..7b33c010bd7 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateSMBFileShareRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateSMBFileShareRequest.h @@ -141,82 +141,82 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateSMBFileShareRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateSMBFileShareRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateSMBFileShareRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateSMBFileShareRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} @@ -714,7 +714,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline const Aws::Vector& GetInvalidUserList() const{ return m_invalidUserList; } @@ -722,7 +722,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline bool InvalidUserListHasBeenSet() const { return m_invalidUserListHasBeenSet; } @@ -730,7 +730,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline void SetInvalidUserList(const Aws::Vector& value) { m_invalidUserListHasBeenSet = true; m_invalidUserList = value; } @@ -738,7 +738,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline void SetInvalidUserList(Aws::Vector&& value) { m_invalidUserListHasBeenSet = true; m_invalidUserList = std::move(value); } @@ -746,7 +746,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline CreateSMBFileShareRequest& WithInvalidUserList(const Aws::Vector& value) { SetInvalidUserList(value); return *this;} @@ -754,7 +754,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline CreateSMBFileShareRequest& WithInvalidUserList(Aws::Vector&& value) { SetInvalidUserList(std::move(value)); return *this;} @@ -762,7 +762,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline CreateSMBFileShareRequest& AddInvalidUserList(const Aws::String& value) { m_invalidUserListHasBeenSet = true; m_invalidUserList.push_back(value); return *this; } @@ -770,7 +770,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline CreateSMBFileShareRequest& AddInvalidUserList(Aws::String&& value) { m_invalidUserListHasBeenSet = true; m_invalidUserList.push_back(std::move(value)); return *this; } @@ -778,7 +778,7 @@ namespace Model /** *

      A list of users or groups in the Active Directory that are not allowed to * access the file share. A group must be prefixed with the @ character. For - * example @group1. Can only be set if Authentication is set to + * example, @group1. Can only be set if Authentication is set to * ActiveDirectory.

      */ inline CreateSMBFileShareRequest& AddInvalidUserList(const char* value) { m_invalidUserListHasBeenSet = true; m_invalidUserList.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateStorediSCSIVolumeRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateStorediSCSIVolumeRequest.h index a76c17eaf99..742d6dcacbb 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateStorediSCSIVolumeRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateStorediSCSIVolumeRequest.h @@ -410,74 +410,74 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateStorediSCSIVolumeRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateStorediSCSIVolumeRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateStorediSCSIVolumeRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side + *

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side * encryption. This value can only be set when KMSEncrypted is true. Optional.

      */ inline CreateStorediSCSIVolumeRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapeWithBarcodeRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapeWithBarcodeRequest.h index 075d34d59a0..751857981d1 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapeWithBarcodeRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapeWithBarcodeRequest.h @@ -108,25 +108,25 @@ namespace Model /** *

      The size, in bytes, of the virtual tape that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline long long GetTapeSizeInBytes() const{ return m_tapeSizeInBytes; } /** *

      The size, in bytes, of the virtual tape that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline bool TapeSizeInBytesHasBeenSet() const { return m_tapeSizeInBytesHasBeenSet; } /** *

      The size, in bytes, of the virtual tape that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline void SetTapeSizeInBytes(long long value) { m_tapeSizeInBytesHasBeenSet = true; m_tapeSizeInBytes = value; } /** *

      The size, in bytes, of the virtual tape that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline CreateTapeWithBarcodeRequest& WithTapeSizeInBytes(long long value) { SetTapeSizeInBytes(value); return *this;} @@ -189,82 +189,82 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateTapeWithBarcodeRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapeWithBarcodeRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapeWithBarcodeRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapeWithBarcodeRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} @@ -274,8 +274,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline const Aws::String& GetPoolId() const{ return m_poolId; } @@ -283,8 +283,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } @@ -292,8 +292,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } @@ -301,8 +301,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } @@ -310,8 +310,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } @@ -319,8 +319,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapeWithBarcodeRequest& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} @@ -328,8 +328,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapeWithBarcodeRequest& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} @@ -337,8 +337,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapeWithBarcodeRequest& WithPoolId(const char* value) { SetPoolId(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapesRequest.h index d1850685d33..6d182e78653 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapesRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/CreateTapesRequest.h @@ -108,25 +108,25 @@ namespace Model /** *

      The size, in bytes, of the virtual tapes that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline long long GetTapeSizeInBytes() const{ return m_tapeSizeInBytes; } /** *

      The size, in bytes, of the virtual tapes that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline bool TapeSizeInBytesHasBeenSet() const { return m_tapeSizeInBytesHasBeenSet; } /** *

      The size, in bytes, of the virtual tapes that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline void SetTapeSizeInBytes(long long value) { m_tapeSizeInBytesHasBeenSet = true; m_tapeSizeInBytes = value; } /** *

      The size, in bytes, of the virtual tapes that you want to create.

      - *

      The size must be aligned by gigabyte (1024*1024*1024 byte).

       + *

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      */ inline CreateTapesRequest& WithTapeSizeInBytes(long long value) { SetTapeSizeInBytes(value); return *this;} @@ -283,82 +283,82 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline CreateTapesRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapesRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapesRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline CreateTapesRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} @@ -368,8 +368,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline const Aws::String& GetPoolId() const{ return m_poolId; } @@ -377,8 +377,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } @@ -386,8 +386,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } @@ -395,8 +395,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } @@ -404,8 +404,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } @@ -413,8 +413,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapesRequest& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} @@ -422,8 +422,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapesRequest& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} @@ -431,8 +431,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline CreateTapesRequest& WithPoolId(const char* value) { SetPoolId(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyRequest.h new file mode 100644 index 00000000000..f013be4a0ff --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyRequest.h @@ -0,0 +1,79 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace StorageGateway +{ +namespace Model +{ + + /** + */ + class AWS_STORAGEGATEWAY_API DeleteAutomaticTapeCreationPolicyRequest : public StorageGatewayRequest + { + public: + DeleteAutomaticTapeCreationPolicyRequest(); + + // 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 "DeleteAutomaticTapeCreationPolicy"; } + + Aws::String SerializePayload() const override; + + Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } + + + inline DeleteAutomaticTapeCreationPolicyRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline DeleteAutomaticTapeCreationPolicyRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline DeleteAutomaticTapeCreationPolicyRequest& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::String m_gatewayARN; + bool m_gatewayARNHasBeenSet; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyResult.h new file mode 100644 index 00000000000..88251c70df6 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteAutomaticTapeCreationPolicyResult.h @@ -0,0 +1,73 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include + +namespace Aws +{ +template +class AmazonWebServiceResult; + +namespace Utils +{ +namespace Json +{ + class JsonValue; +} // namespace Json +} // namespace Utils +namespace StorageGateway +{ +namespace Model +{ + class AWS_STORAGEGATEWAY_API DeleteAutomaticTapeCreationPolicyResult + { + public: + DeleteAutomaticTapeCreationPolicyResult(); + DeleteAutomaticTapeCreationPolicyResult(const Aws::AmazonWebServiceResult& result); + DeleteAutomaticTapeCreationPolicyResult& operator=(const Aws::AmazonWebServiceResult& result); + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARN.assign(value); } + + + inline DeleteAutomaticTapeCreationPolicyResult& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline DeleteAutomaticTapeCreationPolicyResult& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline DeleteAutomaticTapeCreationPolicyResult& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::String m_gatewayARN; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteBandwidthRateLimitResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteBandwidthRateLimitResult.h index e09b2d3825e..4237d8dedb3 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteBandwidthRateLimitResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteBandwidthRateLimitResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway whose bandwidth rate information - * was deleted.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose + * bandwidth rate information was deleted.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteVolumeResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteVolumeResult.h index 56de20338de..2212d64a553 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteVolumeResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DeleteVolumeResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the storage volume that was - * deleted

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the storage volume + * that was deleted

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeBandwidthRateLimitRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeBandwidthRateLimitRequest.h index d5a2d496a2d..bb72b474143 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeBandwidthRateLimitRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeBandwidthRateLimitRequest.h @@ -27,7 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the + * gateway.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCacheResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCacheResult.h index f516f961b06..8e7bab69932 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCacheResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCacheResult.h @@ -67,73 +67,73 @@ namespace Model /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline const Aws::Vector& GetDiskIds() const{ return m_diskIds; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(const Aws::Vector& value) { m_diskIds = value; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline void SetDiskIds(Aws::Vector&& value) { m_diskIds = std::move(value); } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline DescribeCacheResult& WithDiskIds(const Aws::Vector& value) { SetDiskIds(value); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline DescribeCacheResult& WithDiskIds(Aws::Vector&& value) { SetDiskIds(std::move(value)); return *this;} /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline DescribeCacheResult& AddDiskIds(const Aws::String& value) { m_diskIds.push_back(value); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline DescribeCacheResult& AddDiskIds(Aws::String&& value) { m_diskIds.push_back(std::move(value)); return *this; } /** *

      An array of strings that identify disks that are to be configured as working - * storage. Each string have a minimum length of 1 and maximum length of 300. You + * storage. Each string has a minimum length of 1 and maximum length of 300. You * can get the disk IDs from the ListLocalDisks API.

      */ inline DescribeCacheResult& AddDiskIds(const char* value) { m_diskIds.push_back(value); return *this; } /** - *

      The amount of cache in bytes allocated to the a gateway.

      + *

      The amount of cache in bytes allocated to a gateway.

      */ inline long long GetCacheAllocatedInBytes() const{ return m_cacheAllocatedInBytes; } /** - *

      The amount of cache in bytes allocated to the a gateway.

      + *

      The amount of cache in bytes allocated to a gateway.

      */ inline void SetCacheAllocatedInBytes(long long value) { m_cacheAllocatedInBytes = value; } /** - *

      The amount of cache in bytes allocated to the a gateway.

      + *

      The amount of cache in bytes allocated to a gateway.

      */ inline DescribeCacheResult& WithCacheAllocatedInBytes(long long value) { SetCacheAllocatedInBytes(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCachediSCSIVolumesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCachediSCSIVolumesRequest.h index fa191d381da..dc03c165638 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCachediSCSIVolumesRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeCachediSCSIVolumesRequest.h @@ -47,64 +47,64 @@ namespace Model /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline const Aws::Vector& GetVolumeARNs() const{ return m_volumeARNs; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline bool VolumeARNsHasBeenSet() const { return m_volumeARNsHasBeenSet; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline void SetVolumeARNs(const Aws::Vector& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs = value; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline void SetVolumeARNs(Aws::Vector&& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs = std::move(value); } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeCachediSCSIVolumesRequest& WithVolumeARNs(const Aws::Vector& value) { SetVolumeARNs(value); return *this;} /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeCachediSCSIVolumesRequest& WithVolumeARNs(Aws::Vector&& value) { SetVolumeARNs(std::move(value)); return *this;} /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeCachediSCSIVolumesRequest& AddVolumeARNs(const Aws::String& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(value); return *this; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeCachediSCSIVolumesRequest& AddVolumeARNs(Aws::String&& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(std::move(value)); return *this; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a cached volume. All of the specified cached volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a cached volume. All of the specified cached volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeCachediSCSIVolumesRequest& AddVolumeARNs(const char* value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeMaintenanceStartTimeRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeMaintenanceStartTimeRequest.h index 26ac9160b52..b25fd5104c6 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeMaintenanceStartTimeRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeMaintenanceStartTimeRequest.h @@ -27,7 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the + * gateway.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeStorediSCSIVolumesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeStorediSCSIVolumesRequest.h index 3b9d786c093..843db295552 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeStorediSCSIVolumesRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeStorediSCSIVolumesRequest.h @@ -51,64 +51,64 @@ namespace Model /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline const Aws::Vector& GetVolumeARNs() const{ return m_volumeARNs; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline bool VolumeARNsHasBeenSet() const { return m_volumeARNsHasBeenSet; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline void SetVolumeARNs(const Aws::Vector& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs = value; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline void SetVolumeARNs(Aws::Vector&& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs = std::move(value); } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeStorediSCSIVolumesRequest& WithVolumeARNs(const Aws::Vector& value) { SetVolumeARNs(value); return *this;} /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeStorediSCSIVolumesRequest& WithVolumeARNs(Aws::Vector&& value) { SetVolumeARNs(std::move(value)); return *this;} /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeStorediSCSIVolumesRequest& AddVolumeARNs(const Aws::String& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(value); return *this; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeStorediSCSIVolumesRequest& AddVolumeARNs(Aws::String&& value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(std::move(value)); return *this; } /** *

      An array of strings where each string represents the Amazon Resource Name - * (ARN) of a stored volume. All of the specified stored volumes must from the same - * gateway. Use ListVolumes to get volume ARNs for a gateway.

      + * (ARN) of a stored volume. All of the specified stored volumes must be from the + * same gateway. Use ListVolumes to get volume ARNs for a gateway.

      */ inline DescribeStorediSCSIVolumesRequest& AddVolumeARNs(const char* value) { m_volumeARNsHasBeenSet = true; m_volumeARNs.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeTapeArchivesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeTapeArchivesRequest.h index 5c67c670830..2ef6722e5d2 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeTapeArchivesRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeTapeArchivesRequest.h @@ -153,25 +153,25 @@ namespace Model /** - *

      Specifies that the number of virtual tapes descried be limited to the + *

      Specifies that the number of virtual tapes described be limited to the * specified number.

      */ inline int GetLimit() const{ return m_limit; } /** - *

      Specifies that the number of virtual tapes descried be limited to the + *

      Specifies that the number of virtual tapes described be limited to the * specified number.

      */ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** - *

      Specifies that the number of virtual tapes descried be limited to the + *

      Specifies that the number of virtual tapes described be limited to the * specified number.

      */ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** - *

      Specifies that the number of virtual tapes descried be limited to the + *

      Specifies that the number of virtual tapes described be limited to the * specified number.

      */ inline DescribeTapeArchivesRequest& WithLimit(int value) { SetLimit(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeVTLDevicesResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeVTLDevicesResult.h index 0a0db4dd1c4..3884e304908 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeVTLDevicesResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeVTLDevicesResult.h @@ -72,43 +72,43 @@ namespace Model /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline const Aws::Vector& GetVTLDevices() const{ return m_vTLDevices; } /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline void SetVTLDevices(const Aws::Vector& value) { m_vTLDevices = value; } /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline void SetVTLDevices(Aws::Vector&& value) { m_vTLDevices = std::move(value); } /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline DescribeVTLDevicesResult& WithVTLDevices(const Aws::Vector& value) { SetVTLDevices(value); return *this;} /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline DescribeVTLDevicesResult& WithVTLDevices(Aws::Vector&& value) { SetVTLDevices(std::move(value)); return *this;} /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline DescribeVTLDevicesResult& AddVTLDevices(const VTLDevice& value) { m_vTLDevices.push_back(value); return *this; } /** - *

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of + *

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of * the VTL devices.

      */ inline DescribeVTLDevicesResult& AddVTLDevices(VTLDevice&& value) { m_vTLDevices.push_back(std::move(value)); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeWorkingStorageRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeWorkingStorageRequest.h index bdd168aaa28..63cfe6273a3 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeWorkingStorageRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/DescribeWorkingStorageRequest.h @@ -27,7 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the + * gateway.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesRequest.h new file mode 100644 index 00000000000..d2dbaaa7979 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesRequest.h @@ -0,0 +1,79 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +namespace StorageGateway +{ +namespace Model +{ + + /** + */ + class AWS_STORAGEGATEWAY_API ListAutomaticTapeCreationPoliciesRequest : public StorageGatewayRequest + { + public: + ListAutomaticTapeCreationPoliciesRequest(); + + // 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 "ListAutomaticTapeCreationPolicies"; } + + Aws::String SerializePayload() const override; + + Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } + + + inline ListAutomaticTapeCreationPoliciesRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline ListAutomaticTapeCreationPoliciesRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline ListAutomaticTapeCreationPoliciesRequest& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::String m_gatewayARN; + bool m_gatewayARNHasBeenSet; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesResult.h new file mode 100644 index 00000000000..100ac9c7fd7 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListAutomaticTapeCreationPoliciesResult.h @@ -0,0 +1,102 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include + +namespace Aws +{ +template +class AmazonWebServiceResult; + +namespace Utils +{ +namespace Json +{ + class JsonValue; +} // namespace Json +} // namespace Utils +namespace StorageGateway +{ +namespace Model +{ + class AWS_STORAGEGATEWAY_API ListAutomaticTapeCreationPoliciesResult + { + public: + ListAutomaticTapeCreationPoliciesResult(); + ListAutomaticTapeCreationPoliciesResult(const Aws::AmazonWebServiceResult& result); + ListAutomaticTapeCreationPoliciesResult& operator=(const Aws::AmazonWebServiceResult& result); + + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline const Aws::Vector& GetAutomaticTapeCreationPolicyInfos() const{ return m_automaticTapeCreationPolicyInfos; } + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline void SetAutomaticTapeCreationPolicyInfos(const Aws::Vector& value) { m_automaticTapeCreationPolicyInfos = value; } + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline void SetAutomaticTapeCreationPolicyInfos(Aws::Vector&& value) { m_automaticTapeCreationPolicyInfos = std::move(value); } + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline ListAutomaticTapeCreationPoliciesResult& WithAutomaticTapeCreationPolicyInfos(const Aws::Vector& value) { SetAutomaticTapeCreationPolicyInfos(value); return *this;} + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline ListAutomaticTapeCreationPoliciesResult& WithAutomaticTapeCreationPolicyInfos(Aws::Vector&& value) { SetAutomaticTapeCreationPolicyInfos(std::move(value)); return *this;} + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline ListAutomaticTapeCreationPoliciesResult& AddAutomaticTapeCreationPolicyInfos(const AutomaticTapeCreationPolicyInfo& value) { m_automaticTapeCreationPolicyInfos.push_back(value); return *this; } + + /** + *

      Gets a listing of information about the gateway's automatic tape creation + * policies, including the automatic tape creation rules and the gateway that is + * using the policies.

      + */ + inline ListAutomaticTapeCreationPoliciesResult& AddAutomaticTapeCreationPolicyInfos(AutomaticTapeCreationPolicyInfo&& value) { m_automaticTapeCreationPolicyInfos.push_back(std::move(value)); return *this; } + + private: + + Aws::Vector m_automaticTapeCreationPolicyInfos; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListFileSharesRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListFileSharesRequest.h index 37eb2d35b65..26a21111329 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListFileSharesRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListFileSharesRequest.h @@ -48,56 +48,56 @@ namespace Model /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline ListFileSharesRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ inline ListFileSharesRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} /** - *

      The Amazon resource Name (ARN) of the gateway whose file shares you want to + *

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to * list. If this field is not present, all file shares under your account are * listed.

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListLocalDisksRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListLocalDisksRequest.h index 13a137368d0..e53a8a5c6e1 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListLocalDisksRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ListLocalDisksRequest.h @@ -27,7 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the + * gateway.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/NFSFileShareInfo.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/NFSFileShareInfo.h index 3ebe82a84e8..98724264e5b 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/NFSFileShareInfo.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/NFSFileShareInfo.h @@ -173,25 +173,25 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline NFSFileShareInfo& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/RemoveTagsFromResourceRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/RemoveTagsFromResourceRequest.h index 455529e4cce..f30a593b2ec 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/RemoveTagsFromResourceRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/RemoveTagsFromResourceRequest.h @@ -99,55 +99,55 @@ namespace Model /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline const Aws::Vector& GetTagKeys() const{ return m_tagKeys; } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline bool TagKeysHasBeenSet() const { return m_tagKeysHasBeenSet; } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline void SetTagKeys(const Aws::Vector& value) { m_tagKeysHasBeenSet = true; m_tagKeys = value; } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline void SetTagKeys(Aws::Vector&& value) { m_tagKeysHasBeenSet = true; m_tagKeys = std::move(value); } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline RemoveTagsFromResourceRequest& WithTagKeys(const Aws::Vector& value) { SetTagKeys(value); return *this;} /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline RemoveTagsFromResourceRequest& WithTagKeys(Aws::Vector&& value) { SetTagKeys(std::move(value)); return *this;} /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline RemoveTagsFromResourceRequest& AddTagKeys(const Aws::String& value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(value); return *this; } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline RemoveTagsFromResourceRequest& AddTagKeys(Aws::String&& value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(std::move(value)); return *this; } /** *

      The keys of the tags you want to remove from the specified resource. A tag is - * composed of a key/value pair.

      + * composed of a key-value pair.

      */ inline RemoveTagsFromResourceRequest& AddTagKeys(const char* value) { m_tagKeysHasBeenSet = true; m_tagKeys.push_back(value); return *this; } diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayRequest.h index 0784d269e53..78f19947551 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayRequest.h @@ -27,8 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway to shut down.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to + * shut down.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayResult.h index 51466ebb397..4aaa96c9571 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/ShutdownGatewayResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway that was shut down.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that + * was shut down.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayRequest.h index ff554f70d60..3f73ee160cd 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayRequest.h @@ -27,8 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway to start.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to + * start.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayResult.h index 9b304b893a6..6024aabf866 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StartGatewayResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway that was restarted.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that + * was restarted.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StorageGatewayError.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StorageGatewayError.h index 103c75adea8..1ad77159302 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StorageGatewayError.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/StorageGatewayError.h @@ -37,8 +37,8 @@ namespace Model /** *

      Provides additional information about an error that was returned by the - * service as an or. See the errorCode and errorDetails - * members for more information about the error.

      See Also:

      errorCode and errorDetails members + * for more information about the error.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/Tape.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/Tape.h index 350e78b44c4..75a169c51eb 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/Tape.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/Tape.h @@ -355,8 +355,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline const Aws::String& GetPoolId() const{ return m_poolId; } @@ -364,8 +364,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } @@ -373,8 +373,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } @@ -382,8 +382,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } @@ -391,8 +391,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } @@ -400,8 +400,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline Tape& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} @@ -409,8 +409,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline Tape& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} @@ -418,8 +418,8 @@ namespace Model *

      The ID of the pool that contains tapes that will be archived. The tapes in * this pool are archived in the S3 storage class that is associated with the pool. * When you use your backup application to eject the tape, the tape is archived - * directly into the storage class (Glacier or Deep Archive) that corresponds to - * the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that + * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline Tape& WithPoolId(const char* value) { SetPoolId(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/TapeInfo.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/TapeInfo.h index 116be1402cb..e921cd11f77 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/TapeInfo.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/TapeInfo.h @@ -244,8 +244,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline const Aws::String& GetPoolId() const{ return m_poolId; } @@ -253,8 +253,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline bool PoolIdHasBeenSet() const { return m_poolIdHasBeenSet; } @@ -262,8 +262,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const Aws::String& value) { m_poolIdHasBeenSet = true; m_poolId = value; } @@ -271,8 +271,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(Aws::String&& value) { m_poolIdHasBeenSet = true; m_poolId = std::move(value); } @@ -280,8 +280,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline void SetPoolId(const char* value) { m_poolIdHasBeenSet = true; m_poolId.assign(value); } @@ -289,8 +289,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline TapeInfo& WithPoolId(const Aws::String& value) { SetPoolId(value); return *this;} @@ -298,8 +298,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline TapeInfo& WithPoolId(Aws::String&& value) { SetPoolId(std::move(value)); return *this;} @@ -307,8 +307,8 @@ namespace Model *

      The ID of the pool that you want to add your tape to for archiving. The tape * in this pool is archived in the S3 storage class that is associated with the * pool. When you use your backup application to eject the tape, the tape is - * archived directly into the storage class (Glacier or Deep Archive) that - * corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      + * archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) + * that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

      */ inline TapeInfo& WithPoolId(const char* value) { SetPoolId(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyRequest.h new file mode 100644 index 00000000000..f0d9351aa89 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyRequest.h @@ -0,0 +1,141 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include +#include +#include +#include + +namespace Aws +{ +namespace StorageGateway +{ +namespace Model +{ + + /** + */ + class AWS_STORAGEGATEWAY_API UpdateAutomaticTapeCreationPolicyRequest : public StorageGatewayRequest + { + public: + UpdateAutomaticTapeCreationPolicyRequest(); + + // 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 "UpdateAutomaticTapeCreationPolicy"; } + + Aws::String SerializePayload() const override; + + Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline const Aws::Vector& GetAutomaticTapeCreationRules() const{ return m_automaticTapeCreationRules; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline bool AutomaticTapeCreationRulesHasBeenSet() const { return m_automaticTapeCreationRulesHasBeenSet; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline void SetAutomaticTapeCreationRules(const Aws::Vector& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules = value; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline void SetAutomaticTapeCreationRules(Aws::Vector&& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules = std::move(value); } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline UpdateAutomaticTapeCreationPolicyRequest& WithAutomaticTapeCreationRules(const Aws::Vector& value) { SetAutomaticTapeCreationRules(value); return *this;} + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline UpdateAutomaticTapeCreationPolicyRequest& WithAutomaticTapeCreationRules(Aws::Vector&& value) { SetAutomaticTapeCreationRules(std::move(value)); return *this;} + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline UpdateAutomaticTapeCreationPolicyRequest& AddAutomaticTapeCreationRules(const AutomaticTapeCreationRule& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules.push_back(value); return *this; } + + /** + *

      An automatic tape creation policy consists of a list of automatic tape + * creation rules. The rules determine when and how to automatically create new + * tapes.

      + */ + inline UpdateAutomaticTapeCreationPolicyRequest& AddAutomaticTapeCreationRules(AutomaticTapeCreationRule&& value) { m_automaticTapeCreationRulesHasBeenSet = true; m_automaticTapeCreationRules.push_back(std::move(value)); return *this; } + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline bool GatewayARNHasBeenSet() const { return m_gatewayARNHasBeenSet; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARNHasBeenSet = true; m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARNHasBeenSet = true; m_gatewayARN.assign(value); } + + + inline UpdateAutomaticTapeCreationPolicyRequest& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline UpdateAutomaticTapeCreationPolicyRequest& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline UpdateAutomaticTapeCreationPolicyRequest& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::Vector m_automaticTapeCreationRules; + bool m_automaticTapeCreationRulesHasBeenSet; + + Aws::String m_gatewayARN; + bool m_gatewayARNHasBeenSet; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyResult.h new file mode 100644 index 00000000000..50e56418221 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateAutomaticTapeCreationPolicyResult.h @@ -0,0 +1,73 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#pragma once +#include +#include +#include + +namespace Aws +{ +template +class AmazonWebServiceResult; + +namespace Utils +{ +namespace Json +{ + class JsonValue; +} // namespace Json +} // namespace Utils +namespace StorageGateway +{ +namespace Model +{ + class AWS_STORAGEGATEWAY_API UpdateAutomaticTapeCreationPolicyResult + { + public: + UpdateAutomaticTapeCreationPolicyResult(); + UpdateAutomaticTapeCreationPolicyResult(const Aws::AmazonWebServiceResult& result); + UpdateAutomaticTapeCreationPolicyResult& operator=(const Aws::AmazonWebServiceResult& result); + + + + inline const Aws::String& GetGatewayARN() const{ return m_gatewayARN; } + + + inline void SetGatewayARN(const Aws::String& value) { m_gatewayARN = value; } + + + inline void SetGatewayARN(Aws::String&& value) { m_gatewayARN = std::move(value); } + + + inline void SetGatewayARN(const char* value) { m_gatewayARN.assign(value); } + + + inline UpdateAutomaticTapeCreationPolicyResult& WithGatewayARN(const Aws::String& value) { SetGatewayARN(value); return *this;} + + + inline UpdateAutomaticTapeCreationPolicyResult& WithGatewayARN(Aws::String&& value) { SetGatewayARN(std::move(value)); return *this;} + + + inline UpdateAutomaticTapeCreationPolicyResult& WithGatewayARN(const char* value) { SetGatewayARN(value); return *this;} + + private: + + Aws::String m_gatewayARN; + }; + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateBandwidthRateLimitResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateBandwidthRateLimitResult.h index 22f47b08b8b..724bf3ec4cc 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateBandwidthRateLimitResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateBandwidthRateLimitResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway whose throttle information was - * updated.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose + * throttle information was updated.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowRequest.h index 86e3945b61c..51fa963ef01 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowRequest.h @@ -27,8 +27,8 @@ namespace Model { /** - *

      A JSON object containing the of the gateway to update.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to + * update.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowResult.h index 150e458b9b5..394645bbdd3 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateGatewaySoftwareNowResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway that was updated.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that + * was updated.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateMaintenanceStartTimeResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateMaintenanceStartTimeResult.h index 2744bb8260b..d75ab1f468f 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateMaintenanceStartTimeResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateMaintenanceStartTimeResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the gateway whose maintenance start time is - * updated.

      See Also:

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose + * maintenance start time is updated.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateNFSFileShareRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateNFSFileShareRequest.h index c393c1e5abc..429787e71ab 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateNFSFileShareRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateNFSFileShareRequest.h @@ -92,83 +92,83 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline UpdateNFSFileShareRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline UpdateNFSFileShareRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline UpdateNFSFileShareRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. Optional. - *

      + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. + * Optional.

      */ inline UpdateNFSFileShareRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSMBFileShareRequest.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSMBFileShareRequest.h index 4e3c088e833..c9f82aa1e0c 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSMBFileShareRequest.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSMBFileShareRequest.h @@ -99,82 +99,82 @@ namespace Model /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool GetKMSEncrypted() const{ return m_kMSEncrypted; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline bool KMSEncryptedHasBeenSet() const { return m_kMSEncryptedHasBeenSet; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline void SetKMSEncrypted(bool value) { m_kMSEncryptedHasBeenSet = true; m_kMSEncrypted = value; } /** - *

      True to use Amazon S3 server side encryption with your own AWS KMS key, or + *

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or * false to use a key managed by Amazon S3. Optional.

      */ inline UpdateSMBFileShareRequest& WithKMSEncrypted(bool value) { SetKMSEncrypted(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline const Aws::String& GetKMSKey() const{ return m_kMSKey; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline bool KMSKeyHasBeenSet() const { return m_kMSKeyHasBeenSet; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const Aws::String& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = value; } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(Aws::String&& value) { m_kMSKeyHasBeenSet = true; m_kMSKey = std::move(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline void SetKMSKey(const char* value) { m_kMSKeyHasBeenSet = true; m_kMSKey.assign(value); } /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline UpdateSMBFileShareRequest& WithKMSKey(const Aws::String& value) { SetKMSKey(value); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline UpdateSMBFileShareRequest& WithKMSKey(Aws::String&& value) { SetKMSKey(std::move(value)); return *this;} /** - *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server - * side encryption. This value can only be set when KMSEncrypted is true. + *

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 + * server-side encryption. This value can only be set when KMSEncrypted is true. * Optional.

      */ inline UpdateSMBFileShareRequest& WithKMSKey(const char* value) { SetKMSKey(value); return *this;} diff --git a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSnapshotScheduleResult.h b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSnapshotScheduleResult.h index 59a53c11de7..2b1691851e2 100644 --- a/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSnapshotScheduleResult.h +++ b/aws-cpp-sdk-storagegateway/include/aws/storagegateway/model/UpdateSnapshotScheduleResult.h @@ -35,8 +35,8 @@ namespace StorageGateway namespace Model { /** - *

      A JSON object containing the of the updated storage volume.

      See - * Also:

      A JSON object containing the Amazon Resource Name (ARN) of the updated + * storage volume.

      See Also:

      AWS * API Reference

      */ diff --git a/aws-cpp-sdk-storagegateway/source/StorageGatewayClient.cpp b/aws-cpp-sdk-storagegateway/source/StorageGatewayClient.cpp index bc066e26cb2..b1bba150830 100644 --- a/aws-cpp-sdk-storagegateway/source/StorageGatewayClient.cpp +++ b/aws-cpp-sdk-storagegateway/source/StorageGatewayClient.cpp @@ -47,6 +47,7 @@ #include #include #include +#include #include #include #include @@ -76,6 +77,7 @@ #include #include #include +#include #include #include #include @@ -95,6 +97,7 @@ #include #include #include +#include #include #include #include @@ -773,6 +776,41 @@ void StorageGatewayClient::CreateTapesAsyncHelper(const CreateTapesRequest& requ handler(this, request, CreateTapes(request), context); } +DeleteAutomaticTapeCreationPolicyOutcome StorageGatewayClient::DeleteAutomaticTapeCreationPolicy(const DeleteAutomaticTapeCreationPolicyRequest& request) const +{ + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/"; + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_POST, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return DeleteAutomaticTapeCreationPolicyOutcome(DeleteAutomaticTapeCreationPolicyResult(outcome.GetResult())); + } + else + { + return DeleteAutomaticTapeCreationPolicyOutcome(outcome.GetError()); + } +} + +DeleteAutomaticTapeCreationPolicyOutcomeCallable StorageGatewayClient::DeleteAutomaticTapeCreationPolicyCallable(const DeleteAutomaticTapeCreationPolicyRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< DeleteAutomaticTapeCreationPolicyOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->DeleteAutomaticTapeCreationPolicy(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void StorageGatewayClient::DeleteAutomaticTapeCreationPolicyAsync(const DeleteAutomaticTapeCreationPolicyRequest& request, const DeleteAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->DeleteAutomaticTapeCreationPolicyAsyncHelper( request, handler, context ); } ); +} + +void StorageGatewayClient::DeleteAutomaticTapeCreationPolicyAsyncHelper(const DeleteAutomaticTapeCreationPolicyRequest& request, const DeleteAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, DeleteAutomaticTapeCreationPolicy(request), context); +} + DeleteBandwidthRateLimitOutcome StorageGatewayClient::DeleteBandwidthRateLimit(const DeleteBandwidthRateLimitRequest& request) const { Aws::Http::URI uri = m_uri; @@ -1788,6 +1826,41 @@ void StorageGatewayClient::JoinDomainAsyncHelper(const JoinDomainRequest& reques handler(this, request, JoinDomain(request), context); } +ListAutomaticTapeCreationPoliciesOutcome StorageGatewayClient::ListAutomaticTapeCreationPolicies(const ListAutomaticTapeCreationPoliciesRequest& request) const +{ + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/"; + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_POST, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return ListAutomaticTapeCreationPoliciesOutcome(ListAutomaticTapeCreationPoliciesResult(outcome.GetResult())); + } + else + { + return ListAutomaticTapeCreationPoliciesOutcome(outcome.GetError()); + } +} + +ListAutomaticTapeCreationPoliciesOutcomeCallable StorageGatewayClient::ListAutomaticTapeCreationPoliciesCallable(const ListAutomaticTapeCreationPoliciesRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< ListAutomaticTapeCreationPoliciesOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->ListAutomaticTapeCreationPolicies(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void StorageGatewayClient::ListAutomaticTapeCreationPoliciesAsync(const ListAutomaticTapeCreationPoliciesRequest& request, const ListAutomaticTapeCreationPoliciesResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->ListAutomaticTapeCreationPoliciesAsyncHelper( request, handler, context ); } ); +} + +void StorageGatewayClient::ListAutomaticTapeCreationPoliciesAsyncHelper(const ListAutomaticTapeCreationPoliciesRequest& request, const ListAutomaticTapeCreationPoliciesResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, ListAutomaticTapeCreationPolicies(request), context); +} + ListFileSharesOutcome StorageGatewayClient::ListFileShares(const ListFileSharesRequest& request) const { Aws::Http::URI uri = m_uri; @@ -2453,6 +2526,41 @@ void StorageGatewayClient::StartGatewayAsyncHelper(const StartGatewayRequest& re handler(this, request, StartGateway(request), context); } +UpdateAutomaticTapeCreationPolicyOutcome StorageGatewayClient::UpdateAutomaticTapeCreationPolicy(const UpdateAutomaticTapeCreationPolicyRequest& request) const +{ + Aws::Http::URI uri = m_uri; + Aws::StringStream ss; + ss << "/"; + uri.SetPath(uri.GetPath() + ss.str()); + JsonOutcome outcome = MakeRequest(uri, request, Aws::Http::HttpMethod::HTTP_POST, Aws::Auth::SIGV4_SIGNER); + if(outcome.IsSuccess()) + { + return UpdateAutomaticTapeCreationPolicyOutcome(UpdateAutomaticTapeCreationPolicyResult(outcome.GetResult())); + } + else + { + return UpdateAutomaticTapeCreationPolicyOutcome(outcome.GetError()); + } +} + +UpdateAutomaticTapeCreationPolicyOutcomeCallable StorageGatewayClient::UpdateAutomaticTapeCreationPolicyCallable(const UpdateAutomaticTapeCreationPolicyRequest& request) const +{ + auto task = Aws::MakeShared< std::packaged_task< UpdateAutomaticTapeCreationPolicyOutcome() > >(ALLOCATION_TAG, [this, request](){ return this->UpdateAutomaticTapeCreationPolicy(request); } ); + auto packagedFunction = [task]() { (*task)(); }; + m_executor->Submit(packagedFunction); + return task->get_future(); +} + +void StorageGatewayClient::UpdateAutomaticTapeCreationPolicyAsync(const UpdateAutomaticTapeCreationPolicyRequest& request, const UpdateAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + m_executor->Submit( [this, request, handler, context](){ this->UpdateAutomaticTapeCreationPolicyAsyncHelper( request, handler, context ); } ); +} + +void StorageGatewayClient::UpdateAutomaticTapeCreationPolicyAsyncHelper(const UpdateAutomaticTapeCreationPolicyRequest& request, const UpdateAutomaticTapeCreationPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const +{ + handler(this, request, UpdateAutomaticTapeCreationPolicy(request), context); +} + UpdateBandwidthRateLimitOutcome StorageGatewayClient::UpdateBandwidthRateLimit(const UpdateBandwidthRateLimitRequest& request) const { Aws::Http::URI uri = m_uri; diff --git a/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationPolicyInfo.cpp b/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationPolicyInfo.cpp new file mode 100644 index 00000000000..4a156320c25 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationPolicyInfo.cpp @@ -0,0 +1,92 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace StorageGateway +{ +namespace Model +{ + +AutomaticTapeCreationPolicyInfo::AutomaticTapeCreationPolicyInfo() : + m_automaticTapeCreationRulesHasBeenSet(false), + m_gatewayARNHasBeenSet(false) +{ +} + +AutomaticTapeCreationPolicyInfo::AutomaticTapeCreationPolicyInfo(JsonView jsonValue) : + m_automaticTapeCreationRulesHasBeenSet(false), + m_gatewayARNHasBeenSet(false) +{ + *this = jsonValue; +} + +AutomaticTapeCreationPolicyInfo& AutomaticTapeCreationPolicyInfo::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("AutomaticTapeCreationRules")) + { + Array automaticTapeCreationRulesJsonList = jsonValue.GetArray("AutomaticTapeCreationRules"); + for(unsigned automaticTapeCreationRulesIndex = 0; automaticTapeCreationRulesIndex < automaticTapeCreationRulesJsonList.GetLength(); ++automaticTapeCreationRulesIndex) + { + m_automaticTapeCreationRules.push_back(automaticTapeCreationRulesJsonList[automaticTapeCreationRulesIndex].AsObject()); + } + m_automaticTapeCreationRulesHasBeenSet = true; + } + + if(jsonValue.ValueExists("GatewayARN")) + { + m_gatewayARN = jsonValue.GetString("GatewayARN"); + + m_gatewayARNHasBeenSet = true; + } + + return *this; +} + +JsonValue AutomaticTapeCreationPolicyInfo::Jsonize() const +{ + JsonValue payload; + + if(m_automaticTapeCreationRulesHasBeenSet) + { + Array automaticTapeCreationRulesJsonList(m_automaticTapeCreationRules.size()); + for(unsigned automaticTapeCreationRulesIndex = 0; automaticTapeCreationRulesIndex < automaticTapeCreationRulesJsonList.GetLength(); ++automaticTapeCreationRulesIndex) + { + automaticTapeCreationRulesJsonList[automaticTapeCreationRulesIndex].AsObject(m_automaticTapeCreationRules[automaticTapeCreationRulesIndex].Jsonize()); + } + payload.WithArray("AutomaticTapeCreationRules", std::move(automaticTapeCreationRulesJsonList)); + + } + + if(m_gatewayARNHasBeenSet) + { + payload.WithString("GatewayARN", m_gatewayARN); + + } + + return payload; +} + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationRule.cpp b/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationRule.cpp new file mode 100644 index 00000000000..97856b51e57 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/AutomaticTapeCreationRule.cpp @@ -0,0 +1,118 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +namespace Aws +{ +namespace StorageGateway +{ +namespace Model +{ + +AutomaticTapeCreationRule::AutomaticTapeCreationRule() : + m_tapeBarcodePrefixHasBeenSet(false), + m_poolIdHasBeenSet(false), + m_tapeSizeInBytes(0), + m_tapeSizeInBytesHasBeenSet(false), + m_minimumNumTapes(0), + m_minimumNumTapesHasBeenSet(false) +{ +} + +AutomaticTapeCreationRule::AutomaticTapeCreationRule(JsonView jsonValue) : + m_tapeBarcodePrefixHasBeenSet(false), + m_poolIdHasBeenSet(false), + m_tapeSizeInBytes(0), + m_tapeSizeInBytesHasBeenSet(false), + m_minimumNumTapes(0), + m_minimumNumTapesHasBeenSet(false) +{ + *this = jsonValue; +} + +AutomaticTapeCreationRule& AutomaticTapeCreationRule::operator =(JsonView jsonValue) +{ + if(jsonValue.ValueExists("TapeBarcodePrefix")) + { + m_tapeBarcodePrefix = jsonValue.GetString("TapeBarcodePrefix"); + + m_tapeBarcodePrefixHasBeenSet = true; + } + + if(jsonValue.ValueExists("PoolId")) + { + m_poolId = jsonValue.GetString("PoolId"); + + m_poolIdHasBeenSet = true; + } + + if(jsonValue.ValueExists("TapeSizeInBytes")) + { + m_tapeSizeInBytes = jsonValue.GetInt64("TapeSizeInBytes"); + + m_tapeSizeInBytesHasBeenSet = true; + } + + if(jsonValue.ValueExists("MinimumNumTapes")) + { + m_minimumNumTapes = jsonValue.GetInteger("MinimumNumTapes"); + + m_minimumNumTapesHasBeenSet = true; + } + + return *this; +} + +JsonValue AutomaticTapeCreationRule::Jsonize() const +{ + JsonValue payload; + + if(m_tapeBarcodePrefixHasBeenSet) + { + payload.WithString("TapeBarcodePrefix", m_tapeBarcodePrefix); + + } + + if(m_poolIdHasBeenSet) + { + payload.WithString("PoolId", m_poolId); + + } + + if(m_tapeSizeInBytesHasBeenSet) + { + payload.WithInt64("TapeSizeInBytes", m_tapeSizeInBytes); + + } + + if(m_minimumNumTapesHasBeenSet) + { + payload.WithInteger("MinimumNumTapes", m_minimumNumTapes); + + } + + return payload; +} + +} // namespace Model +} // namespace StorageGateway +} // namespace Aws diff --git a/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyRequest.cpp b/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyRequest.cpp new file mode 100644 index 00000000000..075d90ba4e1 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyRequest.cpp @@ -0,0 +1,53 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +DeleteAutomaticTapeCreationPolicyRequest::DeleteAutomaticTapeCreationPolicyRequest() : + m_gatewayARNHasBeenSet(false) +{ +} + +Aws::String DeleteAutomaticTapeCreationPolicyRequest::SerializePayload() const +{ + JsonValue payload; + + if(m_gatewayARNHasBeenSet) + { + payload.WithString("GatewayARN", m_gatewayARN); + + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection DeleteAutomaticTapeCreationPolicyRequest::GetRequestSpecificHeaders() const +{ + Aws::Http::HeaderValueCollection headers; + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "StorageGateway_20130630.DeleteAutomaticTapeCreationPolicy")); + return headers; + +} + + + + diff --git a/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyResult.cpp b/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyResult.cpp new file mode 100644 index 00000000000..7e6605c863d --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/DeleteAutomaticTapeCreationPolicyResult.cpp @@ -0,0 +1,50 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +DeleteAutomaticTapeCreationPolicyResult::DeleteAutomaticTapeCreationPolicyResult() +{ +} + +DeleteAutomaticTapeCreationPolicyResult::DeleteAutomaticTapeCreationPolicyResult(const Aws::AmazonWebServiceResult& result) +{ + *this = result; +} + +DeleteAutomaticTapeCreationPolicyResult& DeleteAutomaticTapeCreationPolicyResult::operator =(const Aws::AmazonWebServiceResult& result) +{ + JsonView jsonValue = result.GetPayload().View(); + if(jsonValue.ValueExists("GatewayARN")) + { + m_gatewayARN = jsonValue.GetString("GatewayARN"); + + } + + + + return *this; +} diff --git a/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesRequest.cpp b/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesRequest.cpp new file mode 100644 index 00000000000..2d10ea7c632 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesRequest.cpp @@ -0,0 +1,53 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +ListAutomaticTapeCreationPoliciesRequest::ListAutomaticTapeCreationPoliciesRequest() : + m_gatewayARNHasBeenSet(false) +{ +} + +Aws::String ListAutomaticTapeCreationPoliciesRequest::SerializePayload() const +{ + JsonValue payload; + + if(m_gatewayARNHasBeenSet) + { + payload.WithString("GatewayARN", m_gatewayARN); + + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection ListAutomaticTapeCreationPoliciesRequest::GetRequestSpecificHeaders() const +{ + Aws::Http::HeaderValueCollection headers; + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "StorageGateway_20130630.ListAutomaticTapeCreationPolicies")); + return headers; + +} + + + + diff --git a/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesResult.cpp b/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesResult.cpp new file mode 100644 index 00000000000..d4fe6a21bfc --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/ListAutomaticTapeCreationPoliciesResult.cpp @@ -0,0 +1,53 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +ListAutomaticTapeCreationPoliciesResult::ListAutomaticTapeCreationPoliciesResult() +{ +} + +ListAutomaticTapeCreationPoliciesResult::ListAutomaticTapeCreationPoliciesResult(const Aws::AmazonWebServiceResult& result) +{ + *this = result; +} + +ListAutomaticTapeCreationPoliciesResult& ListAutomaticTapeCreationPoliciesResult::operator =(const Aws::AmazonWebServiceResult& result) +{ + JsonView jsonValue = result.GetPayload().View(); + if(jsonValue.ValueExists("AutomaticTapeCreationPolicyInfos")) + { + Array automaticTapeCreationPolicyInfosJsonList = jsonValue.GetArray("AutomaticTapeCreationPolicyInfos"); + for(unsigned automaticTapeCreationPolicyInfosIndex = 0; automaticTapeCreationPolicyInfosIndex < automaticTapeCreationPolicyInfosJsonList.GetLength(); ++automaticTapeCreationPolicyInfosIndex) + { + m_automaticTapeCreationPolicyInfos.push_back(automaticTapeCreationPolicyInfosJsonList[automaticTapeCreationPolicyInfosIndex].AsObject()); + } + } + + + + return *this; +} diff --git a/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyRequest.cpp b/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyRequest.cpp new file mode 100644 index 00000000000..6d429965953 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyRequest.cpp @@ -0,0 +1,65 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; + +UpdateAutomaticTapeCreationPolicyRequest::UpdateAutomaticTapeCreationPolicyRequest() : + m_automaticTapeCreationRulesHasBeenSet(false), + m_gatewayARNHasBeenSet(false) +{ +} + +Aws::String UpdateAutomaticTapeCreationPolicyRequest::SerializePayload() const +{ + JsonValue payload; + + if(m_automaticTapeCreationRulesHasBeenSet) + { + Array automaticTapeCreationRulesJsonList(m_automaticTapeCreationRules.size()); + for(unsigned automaticTapeCreationRulesIndex = 0; automaticTapeCreationRulesIndex < automaticTapeCreationRulesJsonList.GetLength(); ++automaticTapeCreationRulesIndex) + { + automaticTapeCreationRulesJsonList[automaticTapeCreationRulesIndex].AsObject(m_automaticTapeCreationRules[automaticTapeCreationRulesIndex].Jsonize()); + } + payload.WithArray("AutomaticTapeCreationRules", std::move(automaticTapeCreationRulesJsonList)); + + } + + if(m_gatewayARNHasBeenSet) + { + payload.WithString("GatewayARN", m_gatewayARN); + + } + + return payload.View().WriteReadable(); +} + +Aws::Http::HeaderValueCollection UpdateAutomaticTapeCreationPolicyRequest::GetRequestSpecificHeaders() const +{ + Aws::Http::HeaderValueCollection headers; + headers.insert(Aws::Http::HeaderValuePair("X-Amz-Target", "StorageGateway_20130630.UpdateAutomaticTapeCreationPolicy")); + return headers; + +} + + + + diff --git a/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyResult.cpp b/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyResult.cpp new file mode 100644 index 00000000000..dcc4e3b4530 --- /dev/null +++ b/aws-cpp-sdk-storagegateway/source/model/UpdateAutomaticTapeCreationPolicyResult.cpp @@ -0,0 +1,50 @@ +/* +* Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. +* +* Licensed under the Apache License, Version 2.0 (the "License"). +* You may not use this file except in compliance with the License. +* A copy of the License is located at +* +* http://aws.amazon.com/apache2.0 +* +* or in the "license" file accompanying this file. This file is distributed +* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either +* express or implied. See the License for the specific language governing +* permissions and limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#include + +using namespace Aws::StorageGateway::Model; +using namespace Aws::Utils::Json; +using namespace Aws::Utils; +using namespace Aws; + +UpdateAutomaticTapeCreationPolicyResult::UpdateAutomaticTapeCreationPolicyResult() +{ +} + +UpdateAutomaticTapeCreationPolicyResult::UpdateAutomaticTapeCreationPolicyResult(const Aws::AmazonWebServiceResult& result) +{ + *this = result; +} + +UpdateAutomaticTapeCreationPolicyResult& UpdateAutomaticTapeCreationPolicyResult::operator =(const Aws::AmazonWebServiceResult& result) +{ + JsonView jsonValue = result.GetPayload().View(); + if(jsonValue.ValueExists("GatewayARN")) + { + m_gatewayARN = jsonValue.GetString("GatewayARN"); + + } + + + + return *this; +} diff --git a/code-generation/api-descriptions/application-autoscaling-2016-02-06.normal.json b/code-generation/api-descriptions/application-autoscaling-2016-02-06.normal.json index 21a638e7fc8..d2de37bf5bf 100644 --- a/code-generation/api-descriptions/application-autoscaling-2016-02-06.normal.json +++ b/code-generation/api-descriptions/application-autoscaling-2016-02-06.normal.json @@ -27,7 +27,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Deletes the specified scaling policy for an Application Auto Scaling scalable target.

      Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

      For more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in the Application Auto Scaling User Guide.

      To create a scaling policy or update an existing one, see PutScalingPolicy.

      " + "documentation":"

      Deletes the specified scaling policy for an Application Auto Scaling scalable target.

      Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

      For more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in the Application Auto Scaling User Guide.

      " }, "DeleteScheduledAction":{ "name":"DeleteScheduledAction", @@ -59,7 +59,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Deregisters an Application Auto Scaling scalable target.

      Deregistering a scalable target deletes the scaling policies that are associated with it.

      To create a scalable target or update an existing one, see RegisterScalableTarget.

      " + "documentation":"

      Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.

      Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.

      " }, "DescribeScalableTargets":{ "name":"DescribeScalableTargets", @@ -75,7 +75,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Gets information about the scalable targets in the specified namespace.

      You can filter the results using ResourceIds and ScalableDimension.

      To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

      " + "documentation":"

      Gets information about the scalable targets in the specified namespace.

      You can filter the results using ResourceIds and ScalableDimension.

      " }, "DescribeScalingActivities":{ "name":"DescribeScalingActivities", @@ -91,7 +91,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

      You can filter the results using ResourceId and ScalableDimension.

      Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

      " + "documentation":"

      Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

      You can filter the results using ResourceId and ScalableDimension.

      " }, "DescribeScalingPolicies":{ "name":"DescribeScalingPolicies", @@ -108,7 +108,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Describes the Application Auto Scaling scaling policies for the specified service namespace.

      You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

      To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

      " + "documentation":"

      Describes the Application Auto Scaling scaling policies for the specified service namespace.

      You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

      For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

      " }, "DescribeScheduledActions":{ "name":"DescribeScheduledActions", @@ -124,7 +124,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Describes the Application Auto Scaling scheduled actions for the specified service namespace.

      You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

      To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

      " + "documentation":"

      Describes the Application Auto Scaling scheduled actions for the specified service namespace.

      You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

      For more information, see Scheduled Scaling in the Application Auto Scaling User Guide.

      " }, "PutScalingPolicy":{ "name":"PutScalingPolicy", @@ -142,7 +142,7 @@ {"shape":"FailedResourceAccessException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Creates or updates a policy for an Application Auto Scaling scalable target.

      Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget.

      To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

      You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

      Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

      Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.

      " + "documentation":"

      Creates or updates a scaling policy for an Application Auto Scaling scalable target.

      Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.

      Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

      For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

      If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.

      " }, "PutScheduledAction":{ "name":"PutScheduledAction", @@ -159,7 +159,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Creates or updates a scheduled action for an Application Auto Scaling scalable target.

      Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using RegisterScalableTarget.

      To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.

      You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

      Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide.

      " + "documentation":"

      Creates or updates a scheduled action for an Application Auto Scaling scalable target.

      Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.

      When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries of when the recurring action starts and stops.

      To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.

      For more information, see Scheduled Scaling in the Application Auto Scaling User Guide.

      If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.

      " }, "RegisterScalableTarget":{ "name":"RegisterScalableTarget", @@ -175,7 +175,7 @@ {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], - "documentation":"

      Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

      When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range.

      To update a scalable target, specify the parameter that you want to change as well as the following parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

      After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets.

      If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

      " + "documentation":"

      Registers or updates a scalable target.

      A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

      When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.

      After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

      To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

      " } }, "shapes":{ @@ -247,7 +247,7 @@ "documentation":"

      The unit of the metric.

      " } }, - "documentation":"

      Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

      To create your customized metric specification:

      • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

      • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

      For more information about CloudWatch, see Amazon CloudWatch Concepts.

      " + "documentation":"

      Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

      For information about the available metrics for a service, see AWS Services That Publish CloudWatch Metrics in the Amazon CloudWatch User Guide.

      To create your customized metric specification:

      • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

      • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.

      For more information about CloudWatch, see Amazon CloudWatch Concepts.

      " }, "DeleteScalingPolicyRequest":{ "type":"structure", @@ -264,15 +264,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " } } }, @@ -292,7 +292,7 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ScheduledActionName":{ "shape":"ResourceIdMaxLen1600", @@ -300,11 +300,11 @@ }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " } } }, @@ -323,15 +323,15 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " } } }, @@ -346,15 +346,15 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceIds":{ "shape":"ResourceIdsMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MaxResults":{ "shape":"MaxResults", @@ -385,15 +385,15 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MaxResults":{ "shape":"MaxResults", @@ -428,15 +428,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MaxResults":{ "shape":"MaxResults", @@ -471,15 +471,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MaxResults":{ "shape":"MaxResults", @@ -600,7 +600,9 @@ "ECSServiceAverageMemoryUtilization", "AppStreamAverageCapacityUtilization", "ComprehendInferenceUtilization", - "LambdaProvisionedConcurrencyUtilization" + "LambdaProvisionedConcurrencyUtilization", + "CassandraReadCapacityUtilization", + "CassandraWriteCapacityUtilization" ] }, "MetricUnit":{"type":"string"}, @@ -639,7 +641,7 @@ "documentation":"

      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or ECS service.

      The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

      • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

      • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

      " } }, - "documentation":"

      Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

      " + "documentation":"

      Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

      Only the AWS services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building Dashboards with CloudWatch in the Application Auto Scaling User Guide.

      " }, "PutScalingPolicyRequest":{ "type":"structure", @@ -656,19 +658,19 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "PolicyType":{ "shape":"PolicyType", - "documentation":"

      The policy type. This parameter is required if you are creating a scaling policy.

      The following policy types are supported:

      TargetTrackingScaling—Not supported for Amazon EMR

      StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda

      For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

      " + "documentation":"

      The policy type. This parameter is required if you are creating a scaling policy.

      The following policy types are supported:

      TargetTrackingScaling—Not supported for Amazon EMR

      StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, or Amazon Keyspaces for Apache Cassandra.

      For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

      " }, "StepScalingPolicyConfiguration":{ "shape":"StepScalingPolicyConfiguration", @@ -705,35 +707,35 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "Schedule":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The schedule for this action. The following formats are supported:

      • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

      • Rate expressions - \"rate(value unit)\"

      • Cron expressions - \"cron(fields)\"

      At expressions are useful for one-time schedules. Specify the time, in UTC.

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      " + "documentation":"

      The schedule for this action. The following formats are supported:

      • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

      • Rate expressions - \"rate(value unit)\"

      • Cron expressions - \"cron(fields)\"

      At expressions are useful for one-time schedules. Specify the time in UTC.

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

      " }, "ScheduledActionName":{ "shape":"ScheduledActionName", - "documentation":"

      The name of the scheduled action.

      " + "documentation":"

      The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "StartTime":{ "shape":"TimestampType", - "documentation":"

      The date and time for the scheduled action to start.

      " + "documentation":"

      The date and time for this scheduled action to start.

      " }, "EndTime":{ "shape":"TimestampType", - "documentation":"

      The date and time for the scheduled action to end.

      " + "documentation":"

      The date and time for the recurring schedule to end.

      " }, "ScalableTargetAction":{ "shape":"ScalableTargetAction", - "documentation":"

      The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

      " + "documentation":"

      The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

      " } } }, @@ -752,27 +754,27 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MinCapacity":{ "shape":"ResourceCapacity", - "documentation":"

      The minimum value to scale to in response to a scale-in event. MinCapacity is required to register a scalable target.

      " + "documentation":"

      The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.

      This parameter is required if you are registering a scalable target. For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.

      " }, "MaxCapacity":{ "shape":"ResourceCapacity", - "documentation":"

      The maximum value to scale to in response to a scale-out event. MaxCapacity is required to register a scalable target.

      " + "documentation":"

      The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.

      This parameter is required if you are registering a scalable target.

      " }, "RoleARN":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.

      For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

      " + "documentation":"

      This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

      If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM Roles.

      " }, "SuspendedState":{ "shape":"SuspendedState", @@ -820,7 +822,9 @@ "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", - "lambda:function:ProvisionedConcurrency" + "lambda:function:ProvisionedConcurrency", + "cassandra:table:ReadCapacityUnits", + "cassandra:table:WriteCapacityUnits" ] }, "ScalableTarget":{ @@ -837,15 +841,15 @@ "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource, or a custom-resource.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "MinCapacity":{ "shape":"ResourceCapacity", @@ -872,7 +876,7 @@ "members":{ "MinCapacity":{ "shape":"ResourceCapacity", - "documentation":"

      The minimum capacity.

      " + "documentation":"

      The minimum capacity.

      For Lambda provisioned concurrency, the minimum value allowed is 0. For all other resources, the minimum value allowed is 1.

      " }, "MaxCapacity":{ "shape":"ResourceCapacity", @@ -908,15 +912,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource, or a custom-resource.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "Description":{ "shape":"XmlString", @@ -987,15 +991,15 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource, or a custom-resource.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "PolicyType":{ "shape":"PolicyType", @@ -1042,19 +1046,19 @@ }, "ServiceNamespace":{ "shape":"ServiceNamespace", - "documentation":"

      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      " + "documentation":"

      The namespace of the AWS service that provides the resource, or a custom-resource.

      " }, "Schedule":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The schedule for this action. The following formats are supported:

      • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

      • Rate expressions - \"rate(value unit)\"

      • Cron expressions - \"cron(fields)\"

      At expressions are useful for one-time schedules. Specify the time, in UTC.

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      " + "documentation":"

      The schedule for this action. The following formats are supported:

      • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

      • Rate expressions - \"rate(value unit)\"

      • Cron expressions - \"cron(fields)\"

      At expressions are useful for one-time schedules. Specify the time in UTC.

      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      For examples of using these expressions, see Scheduled Scaling in the Application Auto Scaling User Guide.

      " }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", - "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      " + "documentation":"

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

      • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

      • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      • Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

      • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

      • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

      • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

      • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

      " }, "ScalableDimension":{ "shape":"ScalableDimension", - "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      " + "documentation":"

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

      • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

      • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

      • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

      • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

      • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

      " }, "StartTime":{ "shape":"TimestampType", @@ -1066,7 +1070,7 @@ }, "ScalableTargetAction":{ "shape":"ScalableTargetAction", - "documentation":"

      The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

      " + "documentation":"

      The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

      " }, "CreationTime":{ "shape":"TimestampType", @@ -1097,7 +1101,8 @@ "sagemaker", "custom-resource", "comprehend", - "lambda" + "lambda", + "cassandra" ] }, "StepAdjustment":{ @@ -1114,10 +1119,10 @@ }, "ScalingAdjustment":{ "shape":"ScalingAdjustment", - "documentation":"

      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

      " + "documentation":"

      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

      " } }, - "documentation":"

      Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

      For the following examples, suppose that you have an alarm with a breach threshold of 50:

      • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

      • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

      There are a few rules for the step adjustments for your step policy:

      • The ranges of your step adjustments can't overlap or have a gap.

      • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

      • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

      • The upper and lower bound can't be null in the same step adjustment.

      " + "documentation":"

      Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

      For the following examples, suppose that you have an alarm with a breach threshold of 50:

      • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

      • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

      There are a few rules for the step adjustments for your step policy:

      • The ranges of your step adjustments can't overlap or have a gap.

      • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

      • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

      • The upper and lower bound can't be null in the same step adjustment.

      " }, "StepAdjustments":{ "type":"list", @@ -1128,19 +1133,19 @@ "members":{ "AdjustmentType":{ "shape":"AdjustmentType", - "documentation":"

      Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.

      " + "documentation":"

      Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.

      AdjustmentType is required if you are adding a new step scaling policy configuration.

      " }, "StepAdjustments":{ "shape":"StepAdjustments", - "documentation":"

      A set of adjustments that enable you to scale based on the size of the alarm breach.

      " + "documentation":"

      A set of adjustments that enable you to scale based on the size of the alarm breach.

      At least one step adjustment is required if you are adding a new step scaling policy configuration.

      " }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", - "documentation":"

      The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

      For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

      " + "documentation":"

      The minimum value to scale by when scaling by percentages. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

      Valid only if the adjustment type is PercentChangeInCapacity.

      " }, "Cooldown":{ "shape":"Cooldown", - "documentation":"

      The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

      For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.

      For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

      " + "documentation":"

      The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

      For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out action are considered part of that capacity and only 1 additional task is added to the desired count.

      For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

      Application Auto Scaling provides a default value of 300 for the following scalable targets:

      • ECS services

      • Spot Fleet requests

      • EMR clusters

      • AppStream 2.0 fleets

      • Aurora DB clusters

      • Amazon SageMaker endpoint variants

      • Custom resources

      For all other scalable targets, the default value is 0:

      • DynamoDB tables

      • DynamoDB global secondary indexes

      • Amazon Comprehend document classification endpoints

      • Lambda provisioned concurrency

      • Amazon Keyspaces tables

      " }, "MetricAggregationType":{ "shape":"MetricAggregationType", @@ -1185,15 +1190,15 @@ }, "ScaleOutCooldown":{ "shape":"Cooldown", - "documentation":"

      The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

      While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

      " + "documentation":"

      The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

      While the cooldown period is in effect, the capacity that has been added by the previous scale-out action that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

      Application Auto Scaling provides a default value of 300 for the following scalable targets:

      • ECS services

      • Spot Fleet requests

      • EMR clusters

      • AppStream 2.0 fleets

      • Aurora DB clusters

      • Amazon SageMaker endpoint variants

      • Custom resources

      For all other scalable targets, the default value is 0:

      • DynamoDB tables

      • DynamoDB global secondary indexes

      • Amazon Comprehend document classification endpoints

      • Lambda provisioned concurrency

      • Amazon Keyspaces tables

      " }, "ScaleInCooldown":{ "shape":"Cooldown", - "documentation":"

      The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.

      The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

      " + "documentation":"

      The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.

      The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

      Application Auto Scaling provides a default value of 300 for the following scalable targets:

      • ECS services

      • Spot Fleet requests

      • EMR clusters

      • AppStream 2.0 fleets

      • Aurora DB clusters

      • Amazon SageMaker endpoint variants

      • Custom resources

      For all other scalable targets, the default value is 0:

      • DynamoDB tables

      • DynamoDB global secondary indexes

      • Amazon Comprehend document classification endpoints

      • Lambda provisioned concurrency

      • Amazon Keyspaces tables

      " }, "DisableScaleIn":{ "shape":"DisableScaleIn", - "documentation":"

      Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.

      " + "documentation":"

      Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

      " } }, "documentation":"

      Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

      " @@ -1212,5 +1217,5 @@ "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, - "documentation":"

      With Application Auto Scaling, you can configure automatic scaling for the following resources:

      • Amazon ECS services

      • Amazon EC2 Spot Fleet requests

      • Amazon EMR clusters

      • Amazon AppStream 2.0 fleets

      • Amazon DynamoDB tables and global secondary indexes throughput capacity

      • Amazon Aurora Replicas

      • Amazon SageMaker endpoint variants

      • Custom resources provided by your own applications or services

      • Amazon Comprehend document classification endpoints

      • AWS Lambda function provisioned concurrency

      API Summary

      The Application Auto Scaling service API includes three key sets of actions:

      • Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.

      • Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.

      • Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities triggered by a scaling policy, and scheduled scaling.

      To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.

      " + "documentation":"

      With Application Auto Scaling, you can configure automatic scaling for the following resources:

      • Amazon ECS services

      • Amazon EC2 Spot Fleet requests

      • Amazon EMR clusters

      • Amazon AppStream 2.0 fleets

      • Amazon DynamoDB tables and global secondary indexes throughput capacity

      • Amazon Aurora Replicas

      • Amazon SageMaker endpoint variants

      • Custom resources provided by your own applications or services

      • Amazon Comprehend document classification endpoints

      • AWS Lambda function provisioned concurrency

      • Amazon Keyspaces for Apache Cassandra tables

      API Summary

      The Application Auto Scaling service API includes three key sets of actions:

      • Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.

      • Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.

      • Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.

      To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.

      " } diff --git a/code-generation/api-descriptions/firehose-2015-08-04.normal.json b/code-generation/api-descriptions/firehose-2015-08-04.normal.json index b7d343d18f7..daa2f5afcb4 100644 --- a/code-generation/api-descriptions/firehose-2015-08-04.normal.json +++ b/code-generation/api-descriptions/firehose-2015-08-04.normal.json @@ -128,7 +128,7 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidKMSResourceException"} ], - "documentation":"

      Enables server-side encryption (SSE) for the delivery stream.

      This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.

      To check the encryption status of a delivery stream, use DescribeDeliveryStream.

      Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. In this case, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement and creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.

      If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.

      If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again.

      You can only enable SSE for a delivery stream that uses DirectPut as its source.

      The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.

      " + "documentation":"

      Enables server-side encryption (SSE) for the delivery stream.

      This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a delivery stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your delivery stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.

      To check the encryption status of a delivery stream, use DescribeDeliveryStream.

      Even if encryption is currently enabled for a delivery stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Kinesis Data Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.

      If a delivery stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.

      If the encryption status of your delivery stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Kinesis Data Firehose to invoke KMS encrypt and decrypt operations.

      You can enable SSE for a delivery stream only if it's a delivery stream that uses DirectPut as its source.

      The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.

      " }, "StopDeliveryStreamEncryption":{ "name":"StopDeliveryStreamEncryption", @@ -247,6 +247,7 @@ }, "ClusterJDBCURL":{ "type":"string", + "max":512, "min":1, "pattern":"jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?Describes a COPY command for Amazon Redshift.

      " }, - "CopyOptions":{"type":"string"}, + "CopyOptions":{ + "type":"string", + "max":204800, + "min":0, + "pattern":".*" + }, "CreateDeliveryStreamInput":{ "type":"structure", "required":["DeliveryStreamName"], @@ -361,15 +368,15 @@ "members":{ "SchemaConfiguration":{ "shape":"SchemaConfiguration", - "documentation":"

      Specifies the AWS Glue Data Catalog table that contains the column information.

      " + "documentation":"

      Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

      " }, "InputFormatConfiguration":{ "shape":"InputFormatConfiguration", - "documentation":"

      Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

      " + "documentation":"

      Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

      " }, "OutputFormatConfiguration":{ "shape":"OutputFormatConfiguration", - "documentation":"

      Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

      " + "documentation":"

      Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

      " }, "Enabled":{ "shape":"BooleanObject", @@ -378,10 +385,17 @@ }, "documentation":"

      Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

      " }, - "DataTableColumns":{"type":"string"}, + "DataTableColumns":{ + "type":"string", + "max":204800, + "min":0, + "pattern":".*" + }, "DataTableName":{ "type":"string", - "min":1 + "max":512, + "min":1, + "pattern":".*" }, "DeleteDeliveryStreamInput":{ "type":"structure", @@ -504,10 +518,10 @@ }, "KeyType":{ "shape":"KeyType", - "documentation":"

      Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

      When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is already encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

      " + "documentation":"

      Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.

      When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement.

      You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException.

      To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service developer guide.

      " } }, - "documentation":"

      Used to specify the type and Amazon Resource Name (ARN) of the CMK needed for Server-Side Encryption (SSE).

      " + "documentation":"

      Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

      " }, "DeliveryStreamEncryptionStatus":{ "type":"string", @@ -530,6 +544,13 @@ "INVALID_KMS_KEY", "KMS_KEY_NOT_FOUND", "KMS_OPT_IN_REQUIRED", + "CREATE_ENI_FAILED", + "DELETE_ENI_FAILED", + "SUBNET_NOT_FOUND", + "SECURITY_GROUP_NOT_FOUND", + "ENI_ACCESS_DENIED", + "SUBNET_ACCESS_DENIED", + "SECURITY_GROUP_ACCESS_DENIED", "UNKNOWN_ERROR" ] }, @@ -651,7 +672,8 @@ "DestinationId":{ "type":"string", "max":100, - "min":1 + "min":1, + "pattern":"[a-zA-Z0-9-]+" }, "ElasticsearchBufferingHints":{ "type":"structure", @@ -738,6 +760,10 @@ "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

      The Amazon CloudWatch logging options for your delivery stream.

      " + }, + "VpcConfiguration":{ + "shape":"VpcConfiguration", + "documentation":"

      The details of the VPC of the Amazon ES destination.

      " } }, "documentation":"

      Describes the configuration of a destination in Amazon ES.

      " @@ -792,6 +818,10 @@ "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

      The Amazon CloudWatch logging options.

      " + }, + "VpcConfigurationDescription":{ + "shape":"VpcConfigurationDescription", + "documentation":"

      The details of the VPC of the Amazon ES destination.

      " } }, "documentation":"

      The destination description in Amazon ES.

      " @@ -855,7 +885,8 @@ "ElasticsearchIndexName":{ "type":"string", "max":80, - "min":1 + "min":1, + "pattern":".*" }, "ElasticsearchIndexRotationPeriod":{ "type":"string", @@ -892,7 +923,8 @@ "ElasticsearchTypeName":{ "type":"string", "max":100, - "min":0 + "min":0, + "pattern":".*" }, "EncryptionConfiguration":{ "type":"structure", @@ -910,7 +942,12 @@ }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, - "ErrorOutputPrefix":{"type":"string"}, + "ErrorOutputPrefix":{ + "type":"string", + "max":1024, + "min":0, + "pattern":".*" + }, "ExtendedS3DestinationConfiguration":{ "type":"structure", "required":[ @@ -1107,7 +1144,12 @@ "max":600, "min":180 }, - "HECEndpoint":{"type":"string"}, + "HECEndpoint":{ + "type":"string", + "max":2048, + "min":0, + "pattern":".*" + }, "HECEndpointType":{ "type":"string", "enum":[ @@ -1115,7 +1157,12 @@ "Event" ] }, - "HECToken":{"type":"string"}, + "HECToken":{ + "type":"string", + "max":2048, + "min":0, + "pattern":".*" + }, "HiveJsonSerDe":{ "type":"structure", "members":{ @@ -1134,7 +1181,7 @@ "documentation":"

      Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

      " } }, - "documentation":"

      Specifies the deserializer you want to use to convert the format of the input data.

      " + "documentation":"

      Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.

      " }, "IntervalInSeconds":{ "type":"integer", @@ -1325,18 +1372,32 @@ "max":50, "min":0 }, - "LogGroupName":{"type":"string"}, - "LogStreamName":{"type":"string"}, + "LogGroupName":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[\\.\\-_/#A-Za-z0-9]*" + }, + "LogStreamName":{ + "type":"string", + "max":512, + "min":0, + "pattern":"[^:*]*" + }, "NoEncryptionConfig":{ "type":"string", "enum":["NoEncryption"] }, "NonEmptyString":{ "type":"string", + "max":1024, + "min":1, "pattern":"^(?!\\s*$).+" }, "NonEmptyStringWithoutWhitespace":{ "type":"string", + "max":1024, + "min":1, "pattern":"^\\S+$" }, "NonNegativeIntegerObject":{ @@ -1438,7 +1499,7 @@ "documentation":"

      Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

      " } }, - "documentation":"

      Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.

      " + "documentation":"

      Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

      " }, "ParquetCompression":{ "type":"string", @@ -1491,10 +1552,17 @@ }, "Password":{ "type":"string", + "max":512, "min":6, + "pattern":".*", "sensitive":true }, - "Prefix":{"type":"string"}, + "Prefix":{ + "type":"string", + "max":1024, + "min":0, + "pattern":".*" + }, "ProcessingConfiguration":{ "type":"structure", "members":{ @@ -1563,7 +1631,8 @@ "ProcessorParameterValue":{ "type":"string", "max":512, - "min":1 + "min":1, + "pattern":"^(?!\\s*$).+" }, "ProcessorType":{ "type":"string", @@ -2059,7 +2128,13 @@ "documentation":"

      Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

      " } }, - "documentation":"

      Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

      " + "documentation":"

      Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

      " + }, + "SecurityGroupIdList":{ + "type":"list", + "member":{"shape":"NonEmptyStringWithoutWhitespace"}, + "max":5, + "min":1 }, "Serializer":{ "type":"structure", @@ -2290,6 +2365,12 @@ "members":{ } }, + "SubnetIdList":{ + "type":"list", + "member":{"shape":"NonEmptyStringWithoutWhitespace"}, + "max":16, + "min":1 + }, "Tag":{ "type":"structure", "required":["Key"], @@ -2336,7 +2417,8 @@ "TagKey":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$" }, "TagKeyList":{ "type":"list", @@ -2347,7 +2429,8 @@ "TagValue":{ "type":"string", "max":256, - "min":0 + "min":0, + "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$" }, "Timestamp":{"type":"timestamp"}, "UntagDeliveryStreamInput":{ @@ -2422,8 +2505,61 @@ }, "Username":{ "type":"string", + "max":512, "min":1, + "pattern":".*", "sensitive":true + }, + "VpcConfiguration":{ + "type":"structure", + "required":[ + "SubnetIds", + "RoleARN", + "SecurityGroupIds" + ], + "members":{ + "SubnetIds":{ + "shape":"SubnetIdList", + "documentation":"

      The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

      The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

      " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

      The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC.

      " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"

      The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination.

      " + } + }, + "documentation":"

      The details of the VPC of the Amazon ES destination.

      " + }, + "VpcConfigurationDescription":{ + "type":"structure", + "required":[ + "SubnetIds", + "RoleARN", + "SecurityGroupIds", + "VpcId" + ], + "members":{ + "SubnetIds":{ + "shape":"SubnetIdList", + "documentation":"

      The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.

      The number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

      " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

      The ARN of the IAM role that you want the delivery stream uses to create endpoints in the destination VPC.

      " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"

      The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in the VPC of the Amazon ES destination.

      " + }, + "VpcId":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

      The ID of the Amazon ES destination's VPC.

      " + } + }, + "documentation":"

      The details of the VPC of the Amazon ES destination.

      " } }, "documentation":"Amazon Kinesis Data Firehose API Reference

      Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.

      " diff --git a/code-generation/api-descriptions/mediapackage-vod-2018-11-07.normal.json b/code-generation/api-descriptions/mediapackage-vod-2018-11-07.normal.json index 784753939cb..8e99301c4c7 100644 --- a/code-generation/api-descriptions/mediapackage-vod-2018-11-07.normal.json +++ b/code-generation/api-descriptions/mediapackage-vod-2018-11-07.normal.json @@ -444,6 +444,49 @@ "documentation": "A collection of MediaPackage VOD PackagingGroup resources.", "shape": "ListPackagingGroupsResponse" } + }, + "ListTagsForResource": { + "documentation": "List tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "name": "ListTagsForResource", + "output": { + "documentation": "200 response", + "shape": "ListTagsForResourceResponse" + } + }, + "TagResource": { + "documentation": "Set tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "POST", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "name": "TagResource" + }, + "UntagResource": { + "documentation": "Delete tags for a given MediaPackage VOD resource", + "errors": [], + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "name": "UntagResource" } }, "shapes": { @@ -497,6 +540,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -528,6 +575,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -591,6 +642,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -658,6 +713,10 @@ "documentation": "The IAM role ARN used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -709,6 +768,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -741,6 +804,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -781,6 +848,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -792,6 +863,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -815,6 +890,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1004,6 +1083,10 @@ "documentation": "The IAM role_arn used to access the source S3 bucket.", "locationName": "sourceRoleArn", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1054,6 +1137,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1088,6 +1175,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1337,6 +1428,28 @@ }, "type": "structure" }, + "ListTagsForResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "ListTagsForResourceResponse": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "type": "structure" + }, "ManifestLayout": { "enum": [ "FULL", @@ -1447,6 +1560,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1479,6 +1596,10 @@ "documentation": "The ID of a PackagingGroup.", "locationName": "packagingGroupId", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -1520,6 +1641,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "type": "structure" @@ -1531,6 +1656,10 @@ "documentation": "The ID of the PackagingGroup.", "locationName": "id", "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" } }, "required": [ @@ -1638,6 +1767,46 @@ }, "type": "structure" }, + "TagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + }, + "Tags": { + "documentation": "A collection of tags associated with a resource", + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, + "TagsModel": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "Tags" + ], + "type": "structure" + }, "TooManyRequestsException": { "documentation": "The client has exceeded their resource or throttling limits.", "error": { @@ -1666,6 +1835,26 @@ }, "type": "structure" }, + "UntagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "TagKeys": { + "documentation": "The key(s) of tag to be deleted", + "location": "querystring", + "locationName": "tagKeys", + "shape": "__listOf__string" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ], + "type": "structure" + }, "__PeriodTriggersElement": { "enum": [ "ADS" @@ -1738,6 +1927,15 @@ "__long": { "type": "long" }, + "__mapOf__string": { + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, "__string": { "type": "string" } diff --git a/code-generation/api-descriptions/pinpoint-2016-12-01.normal.json b/code-generation/api-descriptions/pinpoint-2016-12-01.normal.json index 42f7a0208b2..65366d79a99 100644 --- a/code-generation/api-descriptions/pinpoint-2016-12-01.normal.json +++ b/code-generation/api-descriptions/pinpoint-2016-12-01.normal.json @@ -4475,7 +4475,7 @@ "documentation": "

      The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

      " } ], - "documentation": "

      Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.

      " + "documentation": "

      Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

      " }, "UpdateEndpointsBatch": { "name": "UpdateEndpointsBatch", @@ -4521,7 +4521,7 @@ "documentation": "

      The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

      " } ], - "documentation": "

      Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.

      " + "documentation": "

      Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

      " }, "UpdateGcmChannel": { "name": "UpdateGcmChannel", @@ -5871,7 +5871,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " }, "KpiResult": { "shape": "BaseKpiResult", @@ -5932,7 +5932,7 @@ }, "CampaignHook": { "shape": "CampaignHook", - "documentation": "

      The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.

      " + "documentation": "

      The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

      " }, "LastModifiedDate": { "shape": "__string", @@ -5940,7 +5940,7 @@ }, "Limits": { "shape": "CampaignLimits", - "documentation": "

      The default sending limits for campaigns in the application.

      " + "documentation": "

      The default sending limits for campaigns and journeys in the application.

      " }, "QuietTime": { "shape": "QuietTime", @@ -6181,6 +6181,16 @@ "Rows" ] }, + "CampaignCustomMessage": { + "type": "structure", + "members": { + "Data": { + "shape": "__string", + "documentation": "

      The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

      " + } + }, + "documentation": "

      Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.

      " + }, "CampaignDateRangeKpiResponse": { "type": "structure", "members": { @@ -6198,7 +6208,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " }, "KpiResult": { "shape": "BaseKpiResult", @@ -6268,25 +6278,25 @@ "members": { "LambdaFunctionName": { "shape": "__string", - "documentation": "

      The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

      " + "documentation": "

      The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

      " }, "Mode": { "shape": "Mode", - "documentation": "

      Specifies which Lambda mode to use when invoking the AWS Lambda function.

      " + "documentation": "

      The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

      • FILTER - Invoke the function to customize the segment that's used by a campaign.

      • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

      " }, "WebUrl": { "shape": "__string", "documentation": "

      The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

      " } }, - "documentation": "

      Specifies the AWS Lambda function to use as a code hook for a campaign.

      " + "documentation": "

      Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

      " }, "CampaignLimits": { "type": "structure", "members": { "Daily": { "shape": "__integer", - "documentation": "

      The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

      " + "documentation": "

      The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

      " }, "MaximumDuration": { "shape": "__integer", @@ -6294,14 +6304,14 @@ }, "MessagesPerSecond": { "shape": "__integer", - "documentation": "

      The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

      " + "documentation": "

      The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send each second. The minimum value is 50. The maximum value is 20,000.

      " }, "Total": { "shape": "__integer", - "documentation": "

      The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

      " + "documentation": "

      The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

      " } }, - "documentation": "

      Specifies limits on the messages that a campaign can send.

      " + "documentation": "

      For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns and journeys in the application can send.

      " }, "CampaignResponse": { "type": "structure", @@ -6322,9 +6332,13 @@ "shape": "__string", "documentation": "

      The date, in ISO 8601 format, when the campaign was created.

      " }, + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "

      The delivery configuration settings for sending the campaign through a custom channel.

      " + }, "DefaultState": { "shape": "CampaignState", - "documentation": "

      The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

      " + "documentation": "

      The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

      " }, "Description": { "shape": "__string", @@ -6336,7 +6350,7 @@ }, "Hook": { "shape": "CampaignHook", - "documentation": "

      The settings for the AWS Lambda function to use as a code hook for the campaign.

      " + "documentation": "

      The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      " }, "Id": { "shape": "__string", @@ -6389,11 +6403,11 @@ }, "TreatmentDescription": { "shape": "__string", - "documentation": "

      The custom description of a variation of the campaign that's used for A/B testing.

      " + "documentation": "

      The custom description of the default treatment for the campaign.

      " }, "TreatmentName": { "shape": "__string", - "documentation": "

      The custom name of a variation of the campaign that's used for A/B testing.

      " + "documentation": "

      The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      " }, "Version": { "shape": "__integer", @@ -6434,7 +6448,7 @@ "members": { "CampaignStatus": { "shape": "CampaignStatus", - "documentation": "

      The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

      " + "documentation": "

      The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

      If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

      " } }, "documentation": "

      Provides information about the status of a campaign.

      " @@ -6807,11 +6821,11 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "

      A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

      • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

      • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

      This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.

      " + "documentation": "

      A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

      • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

      • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

      This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

      " }, "Description": { "shape": "__string", - "documentation": "

      A custom description of the configuration for the recommender model. The description can contain up to 128 characters.

      " + "documentation": "

      A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

      " }, "Name": { "shape": "__string", @@ -6819,7 +6833,7 @@ }, "RecommendationProviderIdType": { "shape": "__string", - "documentation": "

      The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

      • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

      • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

      " + "documentation": "

      The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

      • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

      • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

      " }, "RecommendationProviderRoleArn": { "shape": "__string", @@ -6835,11 +6849,11 @@ }, "RecommendationsDisplayName": { "shape": "__string", - "documentation": "

      A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

      " + "documentation": "

      A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

      " }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "

      The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.

      To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      " + "documentation": "

      The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

      To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      " } }, "documentation": "

      Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

      ", @@ -6983,6 +6997,23 @@ ], "payload": "CreateTemplateMessageBody" }, + "CustomDeliveryConfiguration": { + "type": "structure", + "members": { + "DeliveryUri": { + "shape": "__string", + "documentation": "

      The destination to send the campaign or treatment to. This value can be one of the following:

      • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

      • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

      " + }, + "EndpointTypes": { + "shape": "ListOf__EndpointTypesElement", + "documentation": "

      The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

      " + } + }, + "documentation": "

      Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

      ", + "required": [ + "DeliveryUri" + ] + }, "DefaultMessage": { "type": "structure", "members": { @@ -7763,7 +7794,7 @@ "members": { "ConfigurationSet": { "shape": "__string", - "documentation": "

      The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.

      " + "documentation": "

      The Amazon SES configuration set that you want to apply to messages that you send through the channel.

      " }, "Enabled": { "shape": "__boolean", @@ -7797,7 +7828,7 @@ }, "ConfigurationSet": { "shape": "__string", - "documentation": "

      The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.

      " + "documentation": "

      The Amazon SES configuration set that's applied to messages that are sent through the channel.

      " }, "CreationDate": { "shape": "__string", @@ -7809,7 +7840,7 @@ }, "FromAddress": { "shape": "__string", - "documentation": "

      The verified email address that you send email from when you send email through the channel.

      " + "documentation": "

      The verified email address that email is sent from when you send email through the channel.

      " }, "HasCredential": { "shape": "__boolean", @@ -7821,7 +7852,7 @@ }, "Identity": { "shape": "__string", - "documentation": "

      The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.

      " + "documentation": "

      The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

      " }, "IsArchived": { "shape": "__boolean", @@ -7837,7 +7868,7 @@ }, "MessagesPerSecond": { "shape": "__integer", - "documentation": "

      The maximum number of emails that you can send through the channel each second.

      " + "documentation": "

      The maximum number of emails that can be sent through the channel each second.

      " }, "Platform": { "shape": "__string", @@ -8062,7 +8093,7 @@ }, "User": { "shape": "EndpointUser", - "documentation": "

      One or more custom user attributes that describe the user who's associated with the endpoint.

      " + "documentation": "

      One or more custom attributes that describe the user who's associated with the endpoint.

      " } }, "documentation": "

      Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

      " @@ -8241,7 +8272,7 @@ }, "User": { "shape": "EndpointUser", - "documentation": "

      One or more custom user attributes that describe the user who's associated with the endpoint.

      " + "documentation": "

      One or more custom attributes that describe the user who's associated with the endpoint.

      " } }, "documentation": "

      Specifies the channel type and other settings for an endpoint.

      " @@ -8427,10 +8458,7 @@ "documentation": "

      The message identifier (message_id) for the message to use when determining whether message events meet the condition.

      " } }, - "documentation": "

      Specifies the conditions to evaluate for an event that applies to an activity in a journey.

      ", - "required": [ - "Dimensions" - ] + "documentation": "

      Specifies the conditions to evaluate for an event that applies to an activity in a journey.

      " }, "EventDimensions": { "type": "structure", @@ -9073,19 +9101,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "StartTime": { "shape": "__timestampIso8601", @@ -9144,7 +9172,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9211,7 +9239,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9262,19 +9290,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "StartTime": { "shape": "__timestampIso8601", @@ -9393,7 +9421,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9432,7 +9460,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9646,7 +9674,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9743,7 +9771,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -9793,19 +9821,19 @@ "shape": "__string", "location": "uri", "locationName": "kpi-name", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "StartTime": { "shape": "__timestampIso8601", @@ -9857,13 +9885,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " } }, "required": [ @@ -9903,13 +9931,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " } }, "required": [ @@ -10027,7 +10055,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -10062,7 +10090,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "SegmentId": { "shape": "__string", @@ -10107,7 +10135,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "SegmentId": { "shape": "__string", @@ -10225,7 +10253,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "SegmentId": { "shape": "__string", @@ -10270,7 +10298,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -10701,7 +10729,7 @@ }, "KpiName": { "shape": "__string", - "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      " }, "KpiResult": { "shape": "BaseKpiResult", @@ -10761,7 +10789,7 @@ }, "Metrics": { "shape": "MapOf__string", - "documentation": "

      A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

      " } }, "documentation": "

      Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

      ", @@ -10791,7 +10819,7 @@ }, "Metrics": { "shape": "MapOf__string", - "documentation": "

      A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

      " + "documentation": "

      A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

      " } }, "documentation": "

      Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

      ", @@ -10950,7 +10978,7 @@ "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Token": { "shape": "__string", @@ -11025,13 +11053,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "TemplateName": { "shape": "__string", @@ -11070,13 +11098,13 @@ "shape": "__string", "location": "querystring", "locationName": "next-token", - "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "PageSize": { "shape": "__string", "location": "querystring", "locationName": "page-size", - "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

      " + "documentation": "

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      " }, "Prefix": { "shape": "__string", @@ -11177,15 +11205,19 @@ "members": { "ADMMessage": { "shape": "Message", - "documentation": "

      The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

      " + "documentation": "

      The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

      " }, "APNSMessage": { "shape": "Message", - "documentation": "

      The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

      " + "documentation": "

      The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

      " }, "BaiduMessage": { "shape": "Message", - "documentation": "

      The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

      " + "documentation": "

      The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

      " + }, + "CustomMessage": { + "shape": "CampaignCustomMessage", + "documentation": "

      The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

      " }, "DefaultMessage": { "shape": "Message", @@ -11193,15 +11225,15 @@ }, "EmailMessage": { "shape": "CampaignEmailMessage", - "documentation": "

      The message that the campaign sends through the email channel.

      " + "documentation": "

      The message that the campaign sends through the email channel. If specified, this message overrides the default message.

      " }, "GCMMessage": { "shape": "Message", - "documentation": "

      The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

      " + "documentation": "

      The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

      " }, "SMSMessage": { "shape": "CampaignSmsMessage", - "documentation": "

      The message that the campaign sends through the SMS channel.

      " + "documentation": "

      The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

      " } }, "documentation": "

      Specifies the message configuration settings for a campaign.

      " @@ -11828,7 +11860,7 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "

      A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      " + "documentation": "

      A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      " }, "CreationDate": { "shape": "__string", @@ -11868,11 +11900,11 @@ }, "RecommendationsDisplayName": { "shape": "__string", - "documentation": "

      The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console.

      This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      " + "documentation": "

      The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

      This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      " }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "

      The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates.

      " + "documentation": "

      The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

      " } }, "documentation": "

      Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

      ", @@ -12953,6 +12985,10 @@ "TreatmentResource": { "type": "structure", "members": { + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "

      The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

      " + }, "Id": { "shape": "__string", "documentation": "

      The unique identifier for the treatment.

      " @@ -12983,10 +13019,10 @@ }, "TreatmentName": { "shape": "__string", - "documentation": "

      The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      " + "documentation": "

      The custom name of the treatment.

      " } }, - "documentation": "

      Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      ", + "documentation": "

      Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      ", "required": [ "Id", "SizePercent" @@ -13584,11 +13620,11 @@ "members": { "Attributes": { "shape": "MapOf__string", - "documentation": "

      A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

      • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

      • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

      This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.

      " + "documentation": "

      A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

      In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

      • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.

      • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

      This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

      " }, "Description": { "shape": "__string", - "documentation": "

      A custom description of the configuration for the recommender model. The description can contain up to 128 characters.

      " + "documentation": "

      A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

      " }, "Name": { "shape": "__string", @@ -13596,7 +13632,7 @@ }, "RecommendationProviderIdType": { "shape": "__string", - "documentation": "

      The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

      • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

      • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

      " + "documentation": "

      The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

      • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.

      • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

      " }, "RecommendationProviderRoleArn": { "shape": "__string", @@ -13612,11 +13648,11 @@ }, "RecommendationsDisplayName": { "shape": "__string", - "documentation": "

      A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      This name appears in the Attribute finder pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

      " + "documentation": "

      A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

      " }, "RecommendationsPerMessage": { "shape": "__integer", - "documentation": "

      The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.

      To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.

      " + "documentation": "

      The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

      To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

      " } }, "documentation": "

      Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

      ", @@ -14090,7 +14126,7 @@ "members": { "CampaignHook": { "shape": "CampaignHook", - "documentation": "

      The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.

      " + "documentation": "

      The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

      To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

      " }, "CloudWatchMetricsEnabled": { "shape": "__boolean", @@ -14098,7 +14134,7 @@ }, "Limits": { "shape": "CampaignLimits", - "documentation": "

      The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.

      " + "documentation": "

      The default sending limits for campaigns and journeys in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

      " }, "QuietTime": { "shape": "QuietTime", @@ -14114,6 +14150,10 @@ "shape": "ListOfWriteTreatmentResource", "documentation": "

      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      " }, + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "

      The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

      " + }, "Description": { "shape": "__string", "documentation": "

      A custom description of the campaign.

      " @@ -14124,11 +14164,11 @@ }, "Hook": { "shape": "CampaignHook", - "documentation": "

      The settings for the AWS Lambda function to use as a code hook for the campaign.

      " + "documentation": "

      The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

      " }, "IsPaused": { "shape": "__boolean", - "documentation": "

      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.

      " + "documentation": "

      Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

      " }, "Limits": { "shape": "CampaignLimits", @@ -14165,11 +14205,11 @@ }, "TreatmentDescription": { "shape": "__string", - "documentation": "

      A custom description of a variation of the campaign to use for A/B testing.

      " + "documentation": "

      A custom description of the default treatment for the campaign.

      " }, "TreatmentName": { "shape": "__string", - "documentation": "

      A custom name for a variation of the campaign to use for A/B testing.

      " + "documentation": "

      A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

      " } }, "documentation": "

      Specifies the configuration and other settings for a campaign.

      " @@ -14275,6 +14315,10 @@ "WriteTreatmentResource": { "type": "structure", "members": { + "CustomDeliveryConfiguration": { + "shape": "CustomDeliveryConfiguration", + "documentation": "

      The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

      " + }, "MessageConfiguration": { "shape": "MessageConfiguration", "documentation": "

      The message configuration settings for the treatment.

      " @@ -14297,14 +14341,30 @@ }, "TreatmentName": { "shape": "__string", - "documentation": "

      A custom name for the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      " + "documentation": "

      A custom name for the treatment.

      " } }, - "documentation": "

      Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      ", + "documentation": "

      Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      ", "required": [ "SizePercent" ] }, + "__EndpointTypesElement": { + "type": "string", + "enum": [ + "GCM", + "APNS", + "APNS_SANDBOX", + "APNS_VOIP", + "APNS_VOIP_SANDBOX", + "ADM", + "SMS", + "VOICE", + "EMAIL", + "BAIDU", + "CUSTOM" + ] + }, "__boolean": { "type": "boolean" }, @@ -14446,6 +14506,12 @@ "shape": "WriteTreatmentResource" } }, + "ListOf__EndpointTypesElement": { + "type": "list", + "member": { + "shape": "__EndpointTypesElement" + } + }, "ListOf__string": { "type": "list", "member": { diff --git a/code-generation/api-descriptions/ram-2018-01-04.normal.json b/code-generation/api-descriptions/ram-2018-01-04.normal.json index b3b4ce4219c..3f222398263 100644 --- a/code-generation/api-descriptions/ram-2018-01-04.normal.json +++ b/code-generation/api-descriptions/ram-2018-01-04.normal.json @@ -207,6 +207,7 @@ {"shape":"MalformedArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, + {"shape":"ResourceArnNotFoundException"}, {"shape":"ServerInternalException"}, {"shape":"ServiceUnavailableException"} ], @@ -243,6 +244,7 @@ {"shape":"ResourceShareInvitationArnNotFoundException"}, {"shape":"InvalidMaxResultsException"}, {"shape":"MalformedArnException"}, + {"shape":"UnknownResourceException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerInternalException"}, @@ -343,6 +345,22 @@ ], "documentation":"

      Lists the AWS RAM permissions that are associated with a resource share.

      " }, + "ListResourceTypes":{ + "name":"ListResourceTypes", + "http":{ + "method":"POST", + "requestUri":"/listresourcetypes" + }, + "input":{"shape":"ListResourceTypesRequest"}, + "output":{"shape":"ListResourceTypesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

      Lists the shareable resource types supported by AWS RAM.

      " + }, "ListResources":{ "name":"ListResources", "http":{ @@ -376,7 +394,8 @@ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"ServerInternalException"}, - {"shape":"ServiceUnavailableException"} + {"shape":"ServiceUnavailableException"}, + {"shape":"UnknownResourceException"} ], "documentation":"

      Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.

      Use this API action to promote the resource share. When you promote the resource share, it becomes:

      • Visible to all principals that it is shared with.

      • Modifiable in AWS RAM.

      " }, @@ -1058,7 +1077,7 @@ }, "resourceType":{ "shape":"String", - "documentation":"

      The resource type.

      Valid values: ec2:CapacityReservation | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | license-manager:LicenseConfiguration | rds:Cluster | route53resolver:ResolverRule I resource-groups:Group

      " + "documentation":"

      The resource type.

      Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

      " }, "resourceShareArns":{ "shape":"ResourceShareArnList", @@ -1118,6 +1137,32 @@ } } }, + "ListResourceTypesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"

      The token for the next page of results.

      " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      " + } + } + }, + "ListResourceTypesResponse":{ + "type":"structure", + "members":{ + "resourceTypes":{ + "shape":"ServiceNameAndResourceTypeList", + "documentation":"

      The shareable resource types supported by AWS RAM.

      " + }, + "nextToken":{ + "shape":"String", + "documentation":"

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

      " + } + } + }, "ListResourcesRequest":{ "type":"structure", "required":["resourceOwner"], @@ -1132,7 +1177,7 @@ }, "resourceType":{ "shape":"String", - "documentation":"

      The resource type.

      Valid values: ec2:CapacityReservation | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | license-manager:LicenseConfiguration | rds:Cluster | route53resolver:ResolverRule | resource-groups:Group

      " + "documentation":"

      The resource type.

      Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

      " }, "resourceArns":{ "shape":"ResourceArnList", @@ -1696,6 +1741,24 @@ "error":{"httpStatusCode":500}, "exception":true }, + "ServiceNameAndResourceType":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"String", + "documentation":"

      The shareable resource types.

      " + }, + "serviceName":{ + "shape":"String", + "documentation":"

      The name of the AWS services to which the resources belong.

      " + } + }, + "documentation":"

      Information about the shareable resource types and the AWS services to which they belong.

      " + }, + "ServiceNameAndResourceTypeList":{ + "type":"list", + "member":{"shape":"ServiceNameAndResourceType"} + }, "ServiceUnavailableException":{ "type":"structure", "required":["message"], diff --git a/code-generation/api-descriptions/rds-2014-10-31.normal.json b/code-generation/api-descriptions/rds-2014-10-31.normal.json index c5875871d18..aabac40bc67 100644 --- a/code-generation/api-descriptions/rds-2014-10-31.normal.json +++ b/code-generation/api-descriptions/rds-2014-10-31.normal.json @@ -2065,7 +2065,7 @@ {"shape":"DomainNotFoundFault"}, {"shape":"InsufficientStorageClusterCapacityFault"} ], - "documentation":"

      Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

      This action only applies to Aurora DB clusters.

      " + "documentation":"

      Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

      This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

      For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

      This action only applies to Aurora DB clusters.

      " }, "RestoreDBClusterFromSnapshot":{ "name":"RestoreDBClusterFromSnapshot", @@ -2099,7 +2099,7 @@ {"shape":"DomainNotFoundFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"} ], - "documentation":"

      Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.

      The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

      This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

      For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

      " + "documentation":"

      Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.

      The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

      This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

      For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

      This action only applies to Aurora DB clusters.

      " }, "RestoreDBClusterToPointInTime":{ "name":"RestoreDBClusterToPointInTime", @@ -7526,6 +7526,10 @@ "shape":"String", "documentation":"

      The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

      " }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

      The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

      Omit this parameter to show the available offerings in the specified AWS Region.

      " + }, "Vpc":{ "shape":"BooleanOptional", "documentation":"

      A value that indicates whether to show only VPC or non-VPC offerings.

      " @@ -10034,6 +10038,10 @@ "shape":"String", "documentation":"

      The license model for a DB instance.

      " }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

      The Availability Zone group for a DB instance.

      " + }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

      A list of Availability Zones for a DB instance.

      " @@ -10108,7 +10116,7 @@ }, "SupportsStorageAutoscaling":{ "shape":"BooleanOptional", - "documentation":"

      Whether or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.

      " + "documentation":"

      Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

      " }, "SupportsKerberosAuthentication":{ "shape":"BooleanOptional", diff --git a/code-generation/api-descriptions/storagegateway-2013-06-30.normal.json b/code-generation/api-descriptions/storagegateway-2013-06-30.normal.json index 0ecdfba9907..afe3b7e8f01 100644 --- a/code-generation/api-descriptions/storagegateway-2013-06-30.normal.json +++ b/code-generation/api-descriptions/storagegateway-2013-06-30.normal.json @@ -94,7 +94,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " }, "AttachVolume":{ "name":"AttachVolume", @@ -164,7 +164,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways.

      File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

      File gateway does not support creating hard or symbolic links on a file share.

      " + "documentation":"

      Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways.

      File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

      File gateway does not support creating hard or symbolic links on a file share.

      " }, "CreateSMBFileShare":{ "name":"CreateSMBFileShare", @@ -178,7 +178,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.

      File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.

      " + "documentation":"

      Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using an SMB interface. This operation is only supported for file gateways.

      File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

      File gateways don't support creating hard or symbolic links on a file share.

      " }, "CreateSnapshot":{ "name":"CreateSnapshot", @@ -193,7 +193,7 @@ {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableError"} ], - "documentation":"

      Initiates a snapshot of a volume.

      AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.

      In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

      Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

      " + "documentation":"

      Initiates a snapshot of a volume.

      AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage Service (Amazon S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a Snapshot Schedule.

      In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

      Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

      " }, "CreateSnapshotFromVolumeRecoveryPoint":{ "name":"CreateSnapshotFromVolumeRecoveryPoint", @@ -236,7 +236,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

      " + "documentation":"

      Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

      " }, "CreateTapes":{ "name":"CreateTapes", @@ -252,6 +252,20 @@ ], "documentation":"

      Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

      Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

      " }, + "DeleteAutomaticTapeCreationPolicy":{ + "name":"DeleteAutomaticTapeCreationPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAutomaticTapeCreationPolicyInput"}, + "output":{"shape":"DeleteAutomaticTapeCreationPolicyOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

      Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

      " + }, "DeleteBandwidthRateLimit":{ "name":"DeleteBandwidthRateLimit", "http":{ @@ -320,7 +334,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Deletes a snapshot of a volume.

      You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

      To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

      " + "documentation":"

      Deletes a snapshot of a volume.

      You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

      To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

      " }, "DeleteTape":{ "name":"DeleteTape", @@ -404,7 +418,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.

      The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

      " + "documentation":"

      Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

      The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

      " }, "DescribeCachediSCSIVolumes":{ "name":"DescribeCachediSCSIVolumes", @@ -418,7 +432,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

      The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

      " + "documentation":"

      Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

      The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

      " }, "DescribeChapCredentials":{ "name":"DescribeChapCredentials", @@ -530,7 +544,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

      " + "documentation":"

      Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

      " }, "DescribeTapeArchives":{ "name":"DescribeTapeArchives", @@ -642,7 +656,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

      Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

      Once a gateway is disabled it cannot be enabled.

      " + "documentation":"

      Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

      Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

      After a gateway is disabled, it cannot be enabled.

      " }, "JoinDomain":{ "name":"JoinDomain", @@ -658,6 +672,20 @@ ], "documentation":"

      Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

      " }, + "ListAutomaticTapeCreationPolicies":{ + "name":"ListAutomaticTapeCreationPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAutomaticTapeCreationPoliciesInput"}, + "output":{"shape":"ListAutomaticTapeCreationPoliciesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

      Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

      This operation is only supported for tape gateways.

      " + }, "ListFileShares":{ "name":"ListFileShares", "http":{ @@ -824,7 +852,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

      If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

      " + "documentation":"

      Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

      If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

      " }, "RetrieveTapeArchive":{ "name":"RetrieveTapeArchive", @@ -894,7 +922,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

      Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

      The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

      If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

      After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

      When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

      If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

      " + "documentation":"

      Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

      The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

      If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

      After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

      When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

      If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

      " }, "StartAvailabilityMonitorTest":{ "name":"StartAvailabilityMonitorTest", @@ -924,6 +952,20 @@ ], "documentation":"

      Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

      When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

      To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

      " }, + "UpdateAutomaticTapeCreationPolicy":{ + "name":"UpdateAutomaticTapeCreationPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAutomaticTapeCreationPolicyInput"}, + "output":{"shape":"UpdateAutomaticTapeCreationPolicyOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

      Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

      By default, there is no automatic tape creation policy.

      A gateway can have only one automatic tape creation policy.

      " + }, "UpdateBandwidthRateLimit":{ "name":"UpdateBandwidthRateLimit", "http":{ @@ -1144,7 +1186,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " + "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " } } }, @@ -1192,7 +1234,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " + "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " } } }, @@ -1212,7 +1254,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " + "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " } }, "documentation":"

      A JSON object containing one or more of the following fields:

      " @@ -1222,7 +1264,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway for which working storage was configured.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway for which working storage was configured.

      " }, "AssignTapePoolInput":{ "type":"structure", @@ -1237,7 +1279,7 @@ }, "PoolId":{ "shape":"PoolId", - "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " } } }, @@ -1305,6 +1347,55 @@ "max":15, "min":5 }, + "AutomaticTapeCreationPolicyInfo":{ + "type":"structure", + "members":{ + "AutomaticTapeCreationRules":{ + "shape":"AutomaticTapeCreationRules", + "documentation":"

      An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.

      " + }, + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

      Information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

      " + }, + "AutomaticTapeCreationPolicyInfos":{ + "type":"list", + "member":{"shape":"AutomaticTapeCreationPolicyInfo"} + }, + "AutomaticTapeCreationRule":{ + "type":"structure", + "required":[ + "TapeBarcodePrefix", + "PoolId", + "TapeSizeInBytes", + "MinimumNumTapes" + ], + "members":{ + "TapeBarcodePrefix":{ + "shape":"TapeBarcodePrefix", + "documentation":"

      A prefix that you append to the barcode of the virtual tape that you are creating. This prefix makes the barcode unique.

      The prefix must be 1-4 characters in length and must be one of the uppercase letters from A to Z.

      " + }, + "PoolId":{ + "shape":"PoolId", + "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

      The size, in bytes, of the virtual tape capacity.

      " + }, + "MinimumNumTapes":{ + "shape":"MinimumNumTapes", + "documentation":"

      The minimum number of available virtual tapes that the gateway maintains at all times. If the number of tapes on the gateway goes below this value, the gateway creates as many new tapes as are needed to have MinimumNumTapes on the gateway.

      " + } + }, + "documentation":"

      An automatic tape creation policy consists of automatic tape creation rules where each rule defines when and how to create new tapes.

      " + }, + "AutomaticTapeCreationRules":{ + "type":"list", + "member":{"shape":"AutomaticTapeCreationRule"}, + "max":10, + "min":1 + }, "AvailabilityMonitorTestStatus":{ "type":"string", "enum":[ @@ -1514,11 +1605,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "Tags":{ "shape":"Tags", @@ -1562,11 +1653,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "Role":{ "shape":"Role", @@ -1640,11 +1731,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "Role":{ "shape":"Role", @@ -1688,7 +1779,7 @@ }, "InvalidUserList":{ "shape":"FileShareUserList", - "documentation":"

      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

      " + "documentation":"

      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

      " }, "AuditDestinationARN":{ "shape":"AuditDestinationARN", @@ -1822,11 +1913,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "Tags":{ "shape":"Tags", @@ -1867,7 +1958,7 @@ }, "TapeSizeInBytes":{ "shape":"TapeSize", - "documentation":"

      The size, in bytes, of the virtual tape that you want to create.

      The size must be aligned by gigabyte (1024*1024*1024 byte).

      " + "documentation":"

      The size, in bytes, of the virtual tape that you want to create.

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      " }, "TapeBarcode":{ "shape":"TapeBarcode", @@ -1875,15 +1966,15 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "PoolId":{ "shape":"PoolId", - "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " }, "Tags":{ "shape":"Tags", @@ -1918,7 +2009,7 @@ }, "TapeSizeInBytes":{ "shape":"TapeSize", - "documentation":"

      The size, in bytes, of the virtual tapes that you want to create.

      The size must be aligned by gigabyte (1024*1024*1024 byte).

      " + "documentation":"

      The size, in bytes, of the virtual tapes that you want to create.

      The size must be aligned by gigabyte (1024*1024*1024 bytes).

      " }, "ClientToken":{ "shape":"ClientToken", @@ -1934,15 +2025,15 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "PoolId":{ "shape":"PoolId", - "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " }, "Tags":{ "shape":"Tags", @@ -1972,6 +2063,19 @@ "max":6, "min":0 }, + "DeleteAutomaticTapeCreationPolicyInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DeleteAutomaticTapeCreationPolicyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, "DeleteBandwidthRateLimitInput":{ "type":"structure", "required":[ @@ -1992,7 +2096,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway whose bandwidth rate information was deleted.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.

      " }, "DeleteChapCredentialsInput":{ "type":"structure", @@ -2153,7 +2257,7 @@ "documentation":"

      The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

      " } }, - "documentation":"

      A JSON object containing the of the storage volume that was deleted

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted

      " }, "DescribeAvailabilityMonitorTestInput":{ "type":"structure", @@ -2182,7 +2286,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway.

      " }, "DescribeBandwidthRateLimitOutput":{ "type":"structure", @@ -2212,11 +2316,11 @@ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", - "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " + "documentation":"

      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      " }, "CacheAllocatedInBytes":{ "shape":"long", - "documentation":"

      The amount of cache in bytes allocated to the a gateway.

      " + "documentation":"

      The amount of cache in bytes allocated to a gateway.

      " }, "CacheUsedPercentage":{ "shape":"double", @@ -2242,7 +2346,7 @@ "members":{ "VolumeARNs":{ "shape":"VolumeARNs", - "documentation":"

      An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

      " + "documentation":"

      An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

      " } } }, @@ -2354,7 +2458,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway.

      " }, "DescribeMaintenanceStartTimeOutput":{ "type":"structure", @@ -2500,7 +2604,7 @@ "members":{ "VolumeARNs":{ "shape":"VolumeARNs", - "documentation":"

      An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

      " + "documentation":"

      An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must be from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

      " } }, "documentation":"

      A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

      " @@ -2527,7 +2631,7 @@ }, "Limit":{ "shape":"PositiveIntObject", - "documentation":"

      Specifies that the number of virtual tapes descried be limited to the specified number.

      " + "documentation":"

      Specifies that the number of virtual tapes described be limited to the specified number.

      " } }, "documentation":"

      DescribeTapeArchivesInput

      " @@ -2662,7 +2766,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "VTLDevices":{ "shape":"VTLDevices", - "documentation":"

      An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

      " + "documentation":"

      An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL devices.

      " }, "Marker":{ "shape":"Marker", @@ -2677,7 +2781,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway.

      " }, "DescribeWorkingStorageOutput":{ "type":"structure", @@ -3209,7 +3313,7 @@ }, "KMSKey":{ "type":"string", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      ", + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      ", "max":2048, "min":7 }, @@ -3218,12 +3322,27 @@ "max":25, "min":1 }, + "ListAutomaticTapeCreationPoliciesInput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListAutomaticTapeCreationPoliciesOutput":{ + "type":"structure", + "members":{ + "AutomaticTapeCreationPolicyInfos":{ + "shape":"AutomaticTapeCreationPolicyInfos", + "documentation":"

      Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.

      " + } + } + }, "ListFileSharesInput":{ "type":"structure", "members":{ "GatewayARN":{ "shape":"GatewayARN", - "documentation":"

      The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

      " }, "Limit":{ "shape":"PositiveIntObject", @@ -3287,7 +3406,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway.

      " }, "ListLocalDisksOutput":{ "type":"structure", @@ -3453,6 +3572,11 @@ "max":50, "min":2 }, + "MinimumNumTapes":{ + "type":"integer", + "max":10, + "min":1 + }, "MinuteOfHour":{ "type":"integer", "max":59, @@ -3490,7 +3614,7 @@ "GatewayARN":{"shape":"GatewayARN"}, "KMSEncrypted":{ "shape":"boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{"shape":"KMSKey"}, "Path":{"shape":"Path"}, @@ -3670,7 +3794,7 @@ }, "TagKeys":{ "shape":"TagKeys", - "documentation":"

      The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.

      " + "documentation":"

      The keys of the tags you want to remove from the specified resource. A tag is composed of a key-value pair.

      " } }, "documentation":"

      RemoveTagsFromResourceInput

      " @@ -3910,14 +4034,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway to shut down.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.

      " }, "ShutdownGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway that was shut down.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.

      " }, "SnapshotDescription":{ "type":"string", @@ -3953,14 +4077,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway to start.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to start.

      " }, "StartGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway that was restarted.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.

      " }, "StorageClass":{ "type":"string", @@ -3980,7 +4104,7 @@ "documentation":"

      Human-readable text that provides detail about the error that occurred.

      " } }, - "documentation":"

      Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.

      " + "documentation":"

      Provides additional information about an error that was returned by the service. See the errorCode and errorDetails members for more information about the error.

      " }, "StorediSCSIVolume":{ "type":"structure", @@ -4123,7 +4247,7 @@ "KMSKey":{"shape":"KMSKey"}, "PoolId":{ "shape":"PoolId", - "documentation":"

      The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " } }, "documentation":"

      Describes a virtual tape object.

      " @@ -4229,7 +4353,7 @@ }, "PoolId":{ "shape":"PoolId", - "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " + "documentation":"

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

      " } }, "documentation":"

      Describes a virtual tape.

      " @@ -4237,7 +4361,7 @@ "TapeInfos":{ "type":"list", "member":{"shape":"TapeInfo"}, - "documentation":"

      An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.

      " + "documentation":"

      An array of TapeInfo objects, where each object describes a single tape. If there are no tapes in the tape library or VTS, then the TapeInfos is an empty array.

      " }, "TapeRecoveryPointInfo":{ "type":"structure", @@ -4290,6 +4414,26 @@ "max":3600, "min":0 }, + "UpdateAutomaticTapeCreationPolicyInput":{ + "type":"structure", + "required":[ + "AutomaticTapeCreationRules", + "GatewayARN" + ], + "members":{ + "AutomaticTapeCreationRules":{ + "shape":"AutomaticTapeCreationRules", + "documentation":"

      An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

      " + }, + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateAutomaticTapeCreationPolicyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, "UpdateBandwidthRateLimitInput":{ "type":"structure", "required":["GatewayARN"], @@ -4311,7 +4455,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway whose throttle information was updated.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle information was updated.

      " }, "UpdateChapCredentialsInput":{ "type":"structure", @@ -4387,14 +4531,14 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway to update.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway to update.

      " }, "UpdateGatewaySoftwareNowOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway that was updated.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

      " }, "UpdateMaintenanceStartTimeInput":{ "type":"structure", @@ -4429,7 +4573,7 @@ "members":{ "GatewayARN":{"shape":"GatewayARN"} }, - "documentation":"

      A JSON object containing the of the gateway whose maintenance start time is updated.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.

      " }, "UpdateNFSFileShareInput":{ "type":"structure", @@ -4441,11 +4585,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "NFSFileShareDefaults":{ "shape":"NFSFileShareDefaults", @@ -4502,11 +4646,11 @@ }, "KMSEncrypted":{ "shape":"Boolean", - "documentation":"

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " + "documentation":"

      True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

      " }, "KMSKey":{ "shape":"KMSKey", - "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " + "documentation":"

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

      " }, "DefaultStorageClass":{ "shape":"StorageClass", @@ -4620,7 +4764,7 @@ "documentation":"

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

      " } }, - "documentation":"

      A JSON object containing the of the updated storage volume.

      " + "documentation":"

      A JSON object containing the Amazon Resource Name (ARN) of the updated storage volume.

      " }, "UpdateVTLDeviceTypeInput":{ "type":"structure", @@ -4819,5 +4963,5 @@ "long":{"type":"long"}, "string":{"type":"string"} }, - "documentation":"AWS Storage Gateway Service

      AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

      Use the following links to get started using the AWS Storage Gateway Service API Reference:

      AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

      IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

      For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

      arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

      A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

      For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

      " + "documentation":"AWS Storage Gateway Service

      AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery.

      Use the following links to get started using the AWS Storage Gateway Service API Reference:

      AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

      IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

      For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

      arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

      A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

      For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

      " } diff --git a/code-generation/api-descriptions/transfer-2018-11-05.normal.json b/code-generation/api-descriptions/transfer-2018-11-05.normal.json index 63b3b0b26de..42cf12111b2 100644 --- a/code-generation/api-descriptions/transfer-2018-11-05.normal.json +++ b/code-generation/api-descriptions/transfer-2018-11-05.normal.json @@ -6,7 +6,7 @@ "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWS Transfer", - "serviceFullName":"AWS Transfer for SFTP", + "serviceFullName":"AWS Transfer Family", "serviceId":"Transfer", "signatureVersion":"v4", "signingName":"transfer", @@ -23,12 +23,14 @@ "input":{"shape":"CreateServerRequest"}, "output":{"shape":"CreateServerResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"}, - {"shape":"ResourceExistsException"} + {"shape":"ResourceExistsException"}, + {"shape":"ThrottlingException"} ], - "documentation":"

      Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

      " + "documentation":"

      Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

      " }, "CreateUser":{ "name":"CreateUser", @@ -45,7 +47,7 @@ {"shape":"ResourceExistsException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

      " + "documentation":"

      Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

      " }, "DeleteServer":{ "name":"DeleteServer", @@ -55,12 +57,13 @@ }, "input":{"shape":"DeleteServerRequest"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

      No response returns from this operation.

      " + "documentation":"

      Deletes the file transfer protocol-enabled server that you specify.

      No response returns from this operation.

      " }, "DeleteSshPublicKey":{ "name":"DeleteSshPublicKey", @@ -91,7 +94,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Deletes the user belonging to the server you specify.

      No response returns from this operation.

      When you delete a user from a server, the user's information is lost.

      " + "documentation":"

      Deletes the user belonging to a file transfer protocol-enabled server you specify.

      No response returns from this operation.

      When you delete a user from a server, the user's information is lost.

      " }, "DescribeServer":{ "name":"DescribeServer", @@ -107,7 +110,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Describes the server that you specify by passing the ServerId parameter.

      The response contains a description of the server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

      " + "documentation":"

      Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

      The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

      " }, "DescribeUser":{ "name":"DescribeUser", @@ -123,7 +126,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Describes the user assigned to a specific server, as identified by its ServerId property.

      The response from this call returns the properties of the user associated with the ServerId value that was specified.

      " + "documentation":"

      Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

      The response from this call returns the properties of the user associated with the ServerId value that was specified.

      " }, "ImportSshPublicKey":{ "name":"ImportSshPublicKey", @@ -141,7 +144,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

      Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

      The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

      " + "documentation":"

      Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

      The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

      " }, "ListServers":{ "name":"ListServers", @@ -157,7 +160,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"InvalidRequestException"} ], - "documentation":"

      Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

      " + "documentation":"

      Lists the file transfer protocol-enabled servers that are associated with your AWS account.

      " }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -190,7 +193,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      Lists the users for the server that you specify by passing the ServerId parameter.

      " + "documentation":"

      Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

      " }, "StartServer":{ "name":"StartServer", @@ -206,7 +209,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

      Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

      The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

      No response is returned from this call.

      " + "documentation":"

      Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

      The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

      No response is returned from this call.

      " }, "StopServer":{ "name":"StopServer", @@ -222,7 +225,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

      Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

      The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

      No response is returned from this call.

      " + "documentation":"

      Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server will not reduce or impact your file transfer protocol endpoint billing.

      The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

      No response is returned from this call.

      " }, "TagResource":{ "name":"TagResource", @@ -253,7 +256,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

      If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

      " + "documentation":"

      If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

      " }, "UntagResource":{ "name":"UntagResource", @@ -279,6 +282,7 @@ "input":{"shape":"UpdateServerRequest"}, "output":{"shape":"UpdateServerResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceError"}, @@ -287,7 +291,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

      Updates the server properties after that server has been created.

      The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

      " + "documentation":"

      Updates the file transfer protocol-enabled server's properties after that server has been created.

      The UpdateServer call returns the ServerId of the server you updated.

      " }, "UpdateUser":{ "name":"UpdateUser", @@ -308,6 +312,15 @@ } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ServiceErrorMessage"} + }, + "documentation":"

      You do not have sufficient access to perform this action.

      ", + "exception":true, + "synthetic":true + }, "AddressAllocationId":{"type":"string"}, "AddressAllocationIds":{ "type":"list", @@ -319,45 +332,57 @@ "min":20, "pattern":"arn:.*" }, + "Certificate":{ + "type":"string", + "max":1600 + }, "ConflictException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"Message"} }, - "documentation":"

      This exception is thrown when the UpdatServer is called for a server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

      ", + "documentation":"

      This exception is thrown when the UpdatServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

      ", "exception":true }, "CreateServerRequest":{ "type":"structure", "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"

      The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      " + }, "EndpointDetails":{ "shape":"EndpointDetails", - "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

      " + "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

      " }, "EndpointType":{ "shape":"EndpointType", - "documentation":"

      The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.

      " + "documentation":"

      The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

      " }, "HostKey":{ "shape":"HostKey", - "documentation":"

      The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.

      If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.

      " + "documentation":"

      The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.

      If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.

      " }, "IdentityProviderDetails":{ "shape":"IdentityProviderDetails", - "documentation":"

      This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.

      " + "documentation":"

      Required when IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.

      " }, "IdentityProviderType":{ "shape":"IdentityProviderType", - "documentation":"

      Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

      " + "documentation":"

      Specifies the mode of authentication for a file transfer protocol-enabled server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

      " }, "LoggingRole":{ "shape":"Role", - "documentation":"

      A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

      " + "documentation":"

      Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

      " + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      • File Transfer Protocol (FTP): Unencrypted file transfer

      " }, "Tags":{ "shape":"Tags", - "documentation":"

      Key-value pairs that can be used to group and search for servers.

      " + "documentation":"

      Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.

      " } } }, @@ -367,7 +392,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      The service-assigned ID of the SFTP server that is created.

      " + "documentation":"

      The service-assigned ID of the file transfer protocol-enabled server that is created.

      " } } }, @@ -381,31 +406,31 @@ "members":{ "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"

      The landing directory (folder) for a user when they log in to the server using their SFTP client.

      An example is <your-Amazon-S3-bucket-name>/home/username.

      " + "documentation":"

      The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.

      An example is your-Amazon-S3-bucket-name>/home/username.

      " }, "HomeDirectoryType":{ "shape":"HomeDirectoryType", - "documentation":"

      The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

      " + "documentation":"

      The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      " }, "HomeDirectoryMappings":{ "shape":"HomeDirectoryMappings", - "documentation":"

      Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

      '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

      In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

      " + "documentation":"

      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

      '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

      In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a '/' for it to be considered a folder.

      " }, "Policy":{ "shape":"Policy", - "documentation":"

      A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

      For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.

      For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.

      " + "documentation":"

      A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

      For an example of a scope-down policy, see Creating a Scope-Down Policy.

      For more information, see AssumeRole in the AWS Security Token Service API Reference.

      " }, "Role":{ "shape":"Role", - "documentation":"

      The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

      " + "documentation":"

      The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

      " }, "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.

      " }, "SshPublicKeyBody":{ "shape":"SshPublicKeyBody", - "documentation":"

      The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.

      " + "documentation":"

      The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.

      " }, "Tags":{ "shape":"Tags", @@ -413,7 +438,7 @@ }, "UserName":{ "shape":"UserName", - "documentation":"

      A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

      " + "documentation":"

      A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

      " } } }, @@ -426,11 +451,11 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      The ID of the SFTP server that the user is attached to.

      " + "documentation":"

      The ID of the file transfer protocol-enabled server that the user is attached to.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      A unique string that identifies a user account associated with an SFTP server.

      " + "documentation":"

      A unique string that identifies a user account associated with a file transfer protocol-enabled server.

      " } } }, @@ -441,7 +466,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A unique system-assigned identifier for an SFTP server instance.

      " + "documentation":"

      A unique system-assigned identifier for a file transfer protocol-enabled server instance.

      " } } }, @@ -455,7 +480,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

      " }, "SshPublicKeyId":{ "shape":"SshPublicKeyId", @@ -476,11 +501,11 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      A unique string that identifies a user that is being deleted from the server.

      " + "documentation":"

      A unique string that identifies a user that is being deleted from a file transfer protocol-enabled server.

      " } } }, @@ -490,7 +515,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server.

      " } } }, @@ -500,7 +525,7 @@ "members":{ "Server":{ "shape":"DescribedServer", - "documentation":"

      An array containing the properties of the server with the ServerID you specified.

      " + "documentation":"

      An array containing the properties of a file transfer protocol-enabled server with the ServerID you specified.

      " } } }, @@ -513,11 +538,11 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that has this user assigned.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.

      " + "documentation":"

      The name of the user assigned to one or more file transfer protocol-enabled servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.

      " } } }, @@ -530,7 +555,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that has this user assigned.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that has this user assigned.

      " }, "User":{ "shape":"DescribedUser", @@ -544,50 +569,58 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      Specifies the unique Amazon Resource Name (ARN) for the server to be described.

      " + "documentation":"

      Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be described.

      " + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"

      The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      " }, "EndpointDetails":{ "shape":"EndpointDetails", - "documentation":"

      The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

      " + "documentation":"

      The virtual private cloud (VPC) endpoint settings that you configured for your file transfer protocol-enabled server.

      " }, "EndpointType":{ "shape":"EndpointType", - "documentation":"

      The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      " + "documentation":"

      The type of endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      " }, "HostKeyFingerprint":{ "shape":"HostKeyFingerprint", - "documentation":"

      This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.

      " + "documentation":"

      Contains the message-digest algorithm (MD5) hash of a file transfer protocol-enabled server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.

      " }, "IdentityProviderDetails":{ "shape":"IdentityProviderDetails", - "documentation":"

      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.

      " + "documentation":"

      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a file transfer protocol-enabled server is SERVICE_MANAGED.

      " }, "IdentityProviderType":{ "shape":"IdentityProviderType", - "documentation":"

      This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

      " + "documentation":"

      Defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this file transfer protocol-enabled server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

      " }, "LoggingRole":{ "shape":"Role", - "documentation":"

      This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

      " + "documentation":"

      An AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

      " + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      • File Transfer Protocol (FTP): Unencrypted file transfer

      " }, "ServerId":{ "shape":"ServerId", - "documentation":"

      This property is a unique system-assigned identifier for the SFTP server that you instantiate.

      " + "documentation":"

      Unique system-assigned identifier for a file transfer protocol-enabled server that you instantiate.

      " }, "State":{ "shape":"State", - "documentation":"

      The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      " + "documentation":"

      The condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      " }, "Tags":{ "shape":"Tags", - "documentation":"

      This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

      " + "documentation":"

      Contains the key-value pairs that you can use to search for and group file transfer protocol-enabled servers that were assigned to the server that was described.

      " }, "UserCount":{ "shape":"UserCount", - "documentation":"

      The number of users that are assigned to the SFTP server you specified with the ServerId.

      " + "documentation":"

      The number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

      " } }, - "documentation":"

      Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.

      " + "documentation":"

      Describes the properties of a file transfer protocol-enabled server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.

      " }, "DescribedUser":{ "type":"structure", @@ -595,19 +628,19 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

      " + "documentation":"

      Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

      " }, "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"

      This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .

      " + "documentation":"

      Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .

      " }, "HomeDirectoryMappings":{ "shape":"HomeDirectoryMappings", - "documentation":"

      Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.

      In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      " + "documentation":"

      Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.

      In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      " }, "HomeDirectoryType":{ "shape":"HomeDirectoryType", - "documentation":"

      The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

      " + "documentation":"

      The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      " }, "Policy":{ "shape":"Policy", @@ -615,19 +648,19 @@ }, "Role":{ "shape":"Role", - "documentation":"

      This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

      " + "documentation":"

      Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

      " }, "SshPublicKeys":{ "shape":"SshPublicKeys", - "documentation":"

      This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

      " + "documentation":"

      Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

      " }, "Tags":{ "shape":"Tags", - "documentation":"

      This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

      " + "documentation":"

      Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

      " + "documentation":"

      The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.

      " } }, "documentation":"

      Returns properties of the user that you want to describe.

      " @@ -637,11 +670,11 @@ "members":{ "AddressAllocationIds":{ "shape":"AddressAllocationIds", - "documentation":"

      A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the UpdateServer API.

      This property can only be use when EndpointType is set to VPC.

      " + "documentation":"

      A list of address allocation IDs that are required to attach an Elastic IP address to your file transfer protocol-enabled server's endpoint. This is only valid in the UpdateServer API.

      This property can only be use when EndpointType is set to VPC.

      " }, "SubnetIds":{ "shape":"SubnetIds", - "documentation":"

      A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.

      " + "documentation":"

      A list of subnet IDs that are required to host your file transfer protocol-enabled server endpoint in your VPC.

      " }, "VpcEndpointId":{ "shape":"VpcEndpointId", @@ -649,10 +682,10 @@ }, "VpcId":{ "shape":"VpcId", - "documentation":"

      The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.

      " + "documentation":"

      The VPC ID of the VPC in which a file transfer protocol-enabled server's endpoint will be hosted.

      " } }, - "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

      " + "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.

      " }, "EndpointType":{ "type":"string", @@ -709,18 +742,18 @@ "members":{ "Url":{ "shape":"Url", - "documentation":"

      The Url parameter provides contains the location of the service endpoint used to authenticate users.

      " + "documentation":"

      Contains the location of the service endpoint used to authenticate users.

      " }, "InvocationRole":{ "shape":"Role", - "documentation":"

      The InvocationRole parameter provides the type of InvocationRole used to authenticate the user account.

      " + "documentation":"

      Provides the type of InvocationRole used to authenticate the user account.

      " } }, - "documentation":"

      Returns information related to the type of user authentication that is in use for a server's users. A server can have only one method of authentication.

      " + "documentation":"

      Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

      " }, "IdentityProviderType":{ "type":"string", - "documentation":"

      Returns information related to the type of user authentication that is in use for a server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. A server can have only one method of authentication.

      ", + "documentation":"

      Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only one method of authentication.

      ", "enum":[ "SERVICE_MANAGED", "API_GATEWAY" @@ -736,7 +769,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server.

      " }, "SshPublicKeyBody":{ "shape":"SshPublicKeyBody", @@ -744,7 +777,7 @@ }, "UserName":{ "shape":"UserName", - "documentation":"

      The name of the user account that is assigned to one or more servers.

      " + "documentation":"

      The name of the user account that is assigned to one or more file transfer protocol-enabled servers.

      " } } }, @@ -758,18 +791,18 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server.

      " }, "SshPublicKeyId":{ "shape":"SshPublicKeyId", - "documentation":"

      This identifier is the name given to a public key by the system that was imported.

      " + "documentation":"

      The name given to a public key by the system that was imported.

      " }, "UserName":{ "shape":"UserName", "documentation":"

      A user name assigned to the ServerID value that you specified.

      " } }, - "documentation":"

      This response identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

      " + "documentation":"

      Identifies the user, the file transfer protocol-enabled server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

      " }, "InternalServiceError":{ "type":"structure", @@ -777,7 +810,7 @@ "members":{ "Message":{"shape":"Message"} }, - "documentation":"

      This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

      ", + "documentation":"

      This exception is thrown when an error occurs in the AWS Transfer Family service.

      ", "exception":true, "fault":true }, @@ -804,11 +837,11 @@ "members":{ "MaxResults":{ "shape":"MaxResults", - "documentation":"

      Specifies the number of servers to return as a response to the ListServers query.

      " + "documentation":"

      Specifies the number of file transfer protocol-enabled servers to return as a response to the ListServers query.

      " }, "NextToken":{ "shape":"NextToken", - "documentation":"

      When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

      " + "documentation":"

      When additional results are obtained from theListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional file transfer protocol-enabled servers.

      " } } }, @@ -818,11 +851,11 @@ "members":{ "NextToken":{ "shape":"NextToken", - "documentation":"

      When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

      " + "documentation":"

      When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional file transfer protocol-enabled servers.

      " }, "Servers":{ "shape":"ListedServers", - "documentation":"

      An array of servers that were listed.

      " + "documentation":"

      An array of file transfer protocol-enabled servers that were listed.

      " } } }, @@ -849,7 +882,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      This value is the ARN you specified to list the tags of.

      " + "documentation":"

      The ARN you specified to list the tags of.

      " }, "NextToken":{ "shape":"NextToken", @@ -875,7 +908,7 @@ }, "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.

      " } } }, @@ -892,7 +925,7 @@ }, "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that the users are assigned to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.

      " }, "Users":{ "shape":"ListedUsers", @@ -906,34 +939,34 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      The unique Amazon Resource Name (ARN) for the server to be listed.

      " + "documentation":"

      The unique Amazon Resource Name (ARN) for a file transfer protocol-enabled server to be listed.

      " }, "IdentityProviderType":{ "shape":"IdentityProviderType", - "documentation":"

      The authentication method used to validate a user for the server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

      " + "documentation":"

      The authentication method used to validate a user for a file transfer protocol-enabled server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

      " }, "EndpointType":{ "shape":"EndpointType", - "documentation":"

      The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      " + "documentation":"

      The type of VPC endpoint that your file transfer protocol-enabled server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      " }, "LoggingRole":{ "shape":"Role", - "documentation":"

      The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

      " + "documentation":"

      The AWS Identity and Access Management (IAM) entity that allows a file transfer protocol-enabled server to turn on Amazon CloudWatch logging.

      " }, "ServerId":{ "shape":"ServerId", - "documentation":"

      This value is the unique system assigned identifier for the SFTP servers that were listed.

      " + "documentation":"

      The unique system assigned identifier for a file transfer protocol-enabled servers that were listed.

      " }, "State":{ "shape":"State", - "documentation":"

      This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      " + "documentation":"

      Describes the condition of a file transfer protocol-enabled server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      " }, "UserCount":{ "shape":"UserCount", - "documentation":"

      This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.

      " + "documentation":"

      A numeric value that indicates the number of users that are assigned to a file transfer protocol-enabled server you specified with the ServerId.

      " } }, - "documentation":"

      Returns properties of the server that was specified.

      " + "documentation":"

      Returns properties of a file transfer protocol-enabled server that was specified.

      " }, "ListedServers":{ "type":"list", @@ -945,23 +978,23 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.

      " + "documentation":"

      The unique Amazon Resource Name (ARN) for the user that you want to learn about.

      " }, "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"

      This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

      " + "documentation":"

      Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

      " }, "HomeDirectoryType":{ "shape":"HomeDirectoryType", - "documentation":"

      The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

      " + "documentation":"

      The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      " }, "Role":{ "shape":"Role", - "documentation":"

      The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

      " + "documentation":"

      The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

      " }, "SshPublicKeyCount":{ "shape":"SshPublicKeyCount", - "documentation":"

      This value is the number of SSH public keys stored for the user you specified.

      " + "documentation":"

      The number of SSH public keys stored for the user you specified.

      " }, "UserName":{ "shape":"UserName", @@ -1004,6 +1037,20 @@ "type":"string", "max":2048 }, + "Protocol":{ + "type":"string", + "enum":[ + "SFTP", + "FTP", + "FTPS" + ] + }, + "Protocols":{ + "type":"list", + "member":{"shape":"Protocol"}, + "max":3, + "min":1 + }, "Resource":{"type":"string"}, "ResourceExistsException":{ "type":"structure", @@ -1032,7 +1079,7 @@ "Resource":{"shape":"Resource"}, "ResourceType":{"shape":"ResourceType"} }, - "documentation":"

      This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

      ", + "documentation":"

      This exception is thrown when a resource is not found by the AWS Transfer Family service.

      ", "exception":true }, "ResourceType":{"type":"string"}, @@ -1056,7 +1103,7 @@ "members":{ "Message":{"shape":"ServiceErrorMessage"} }, - "documentation":"

      The request has failed because the AWS Transfer for SFTP service is not available.

      ", + "documentation":"

      The request has failed because the AWS Transfer Family service is not available.

      ", "exception":true, "fault":true, "synthetic":true @@ -1082,7 +1129,7 @@ "documentation":"

      The SshPublicKeyId parameter contains the identifier of the public key.

      " } }, - "documentation":"

      Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.

      " + "documentation":"

      Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

      " }, "SshPublicKeyBody":{ "type":"string", @@ -1107,13 +1154,13 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that you start.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that you start.

      " } } }, "State":{ "type":"string", - "documentation":"

      Describes the condition of the SFTP server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

      OFFLINE indicates that the SFTP server exists, but that it is not available for file operations. ONLINE indicates that the SFTP server is available to perform file operations. STARTING indicates that the SFTP server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for an SFTP server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

      ", + "documentation":"

      Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

      OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

      ", "enum":[ "OFFLINE", "ONLINE", @@ -1130,7 +1177,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that you stopped.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that you stopped.

      " } } }, @@ -1152,7 +1199,7 @@ }, "Value":{ "shape":"TagValue", - "documentation":"

      This property contains one or more values that you assigned to the key name you create.

      " + "documentation":"

      Contains one or more values that you assigned to the key name you create.

      " } }, "documentation":"

      Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

      " @@ -1203,15 +1250,19 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

      " + "documentation":"

      A system-assigned identifier for a specific file transfer protocol-enabled server. That server's user authentication method is tested with a user name and password.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      This request parameter is the name of the user account to be tested.

      " + "documentation":"

      The name of the user account to be tested.

      " }, "UserPassword":{ "shape":"UserPassword", "documentation":"

      The password of the user account to be tested.

      " + }, + "ServerProtocol":{ + "shape":"Protocol", + "documentation":"

      The type of file transfer protocol to be tested.

      The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP)

      • File Transfer Protocol Secure (FTPS)

      • File Transfer Protocol (FTP)

      " } } }, @@ -1232,7 +1283,7 @@ }, "Message":{ "shape":"Message", - "documentation":"

      A message that indicates whether the test was successful or not.

      " + "documentation":"

      A message that indicates whether the test was successful or not.

      " }, "Url":{ "shape":"Url", @@ -1257,7 +1308,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

      This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

      " + "documentation":"

      The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

      " }, "TagKeys":{ "shape":"TagKeys", @@ -1269,29 +1320,37 @@ "type":"structure", "required":["ServerId"], "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"

      The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      " + }, "EndpointDetails":{ "shape":"EndpointDetails", - "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

      " + "documentation":"

      The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

      " }, "EndpointType":{ "shape":"EndpointType", - "documentation":"

      The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

      " + "documentation":"

      The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, your server isn't accessible over the public internet.

      " }, "HostKey":{ "shape":"HostKey", - "documentation":"

      The RSA private key as generated by ssh-keygen -N \"\" -f my-new-server-key.

      If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see \"https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.

      " + "documentation":"

      The RSA private key as generated by ssh-keygen -N \"\" -f my-new-server-key.

      If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

      For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.

      " }, "IdentityProviderDetails":{ "shape":"IdentityProviderDetails", - "documentation":"

      This response parameter is an array containing all of the information required to call a customer's authentication API method.

      " + "documentation":"

      An array containing all of the information required to call a customer's authentication API method.

      " }, "LoggingRole":{ "shape":"NullableRole", - "documentation":"

      A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

      " + "documentation":"

      Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

      " + }, + "Protocols":{ + "shape":"Protocols", + "documentation":"

      Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

      • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH

      • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption

      • File Transfer Protocol (FTP): Unencrypted file transfer

      " }, "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

      " } } }, @@ -1301,7 +1360,7 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server that the user account is assigned to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.

      " } } }, @@ -1314,31 +1373,31 @@ "members":{ "HomeDirectory":{ "shape":"HomeDirectory", - "documentation":"

      A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client.

      An example is <your-Amazon-S3-bucket-name>/home/username.

      " + "documentation":"

      Specifies the landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using their file transfer protocol client.

      An example is your-Amazon-S3-bucket-name>/home/username.

      " }, "HomeDirectoryType":{ "shape":"HomeDirectoryType", - "documentation":"

      The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP serve. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

      " + "documentation":"

      The type of landing directory (folder) you want your users' home directory to be when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

      " }, "HomeDirectoryMappings":{ "shape":"HomeDirectoryMappings", - "documentation":"

      Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

      '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

      In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

      " + "documentation":"

      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

      '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

      In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

      " }, "Policy":{ "shape":"Policy", - "documentation":"

      Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

      For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.

      For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.

      " + "documentation":"

      Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

      For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

      For an example of a scope-down policy, see Creating a Scope-Down Policy.

      For more information, see AssumeRole in the AWS Security Token Service API Reference.

      " }, "Role":{ "shape":"Role", - "documentation":"

      The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.

      " + "documentation":"

      The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.

      " }, "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

      " + "documentation":"

      A unique string that identifies a user and is associated with a file transfer protocol-enabled server as specified by the ServerId. This is the string that will be used by your user when they log in to your server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

      " } } }, @@ -1351,14 +1410,14 @@ "members":{ "ServerId":{ "shape":"ServerId", - "documentation":"

      A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

      " + "documentation":"

      A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

      " }, "UserName":{ "shape":"UserName", - "documentation":"

      The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.

      " + "documentation":"

      The unique identifier for a user that is assigned to a file transfer protocol-enabled server instance that was specified in the request.

      " } }, - "documentation":"

      UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.

      " + "documentation":"

      UpdateUserResponse returns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.

      " }, "Url":{ "type":"string", @@ -1384,5 +1443,5 @@ }, "VpcId":{"type":"string"} }, - "documentation":"

      AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up.

      " + "documentation":"

      AWS Transfer Family is a fully managed service that enables the transfer of files over the the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.

      " }