AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
For more information about AWS Cloud9, see the AWS Cloud9 User Guide.
AWS Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
ListTagsForResource: Gets the tags for an environment.
TagResource: Adds tags to an environment.
UntagResource: Removes tags from an environment.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.
For more information about Cloud9, see the Cloud9 User Guide.
Cloud9 supports these operations:
CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
ListTagsForResource: Gets the tags for an environment.
TagResource: Adds tags to an environment.
UntagResource: Removes tags from an environment.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.
Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
", - "CreateEnvironmentMembership": "Adds an environment member to an AWS Cloud9 development environment.
", - "DeleteEnvironment": "Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
", - "DeleteEnvironmentMembership": "Deletes an environment member from an AWS Cloud9 development environment.
", - "DescribeEnvironmentMemberships": "Gets information about environment members for an AWS Cloud9 development environment.
", - "DescribeEnvironmentStatus": "Gets status information for an AWS Cloud9 development environment.
", - "DescribeEnvironments": "Gets information about AWS Cloud9 development environments.
", - "ListEnvironments": "Gets a list of AWS Cloud9 development environment identifiers.
", - "ListTagsForResource": "Gets a list of the tags associated with an AWS Cloud9 development environment.
", - "TagResource": "Adds tags to an AWS Cloud9 development environment.
Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.
Removes tags from an AWS Cloud9 development environment.
", - "UpdateEnvironment": "Changes the settings of an existing AWS Cloud9 development environment.
", - "UpdateEnvironmentMembership": "Changes the settings of an existing environment member for an AWS Cloud9 development environment.
" + "CreateEnvironmentEC2": "Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.
", + "CreateEnvironmentMembership": "Adds an environment member to an Cloud9 development environment.
", + "DeleteEnvironment": "Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
", + "DeleteEnvironmentMembership": "Deletes an environment member from an Cloud9 development environment.
", + "DescribeEnvironmentMemberships": "Gets information about environment members for an Cloud9 development environment.
", + "DescribeEnvironmentStatus": "Gets status information for an Cloud9 development environment.
", + "DescribeEnvironments": "Gets information about Cloud9 development environments.
", + "ListEnvironments": "Gets a list of Cloud9 development environment identifiers.
", + "ListTagsForResource": "Gets a list of the tags associated with an Cloud9 development environment.
", + "TagResource": "Adds tags to an Cloud9 development environment.
Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.
Removes tags from an Cloud9 development environment.
", + "UpdateEnvironment": "Changes the settings of an existing Cloud9 development environment.
", + "UpdateEnvironmentMembership": "Changes the settings of an existing environment member for an Cloud9 development environment.
" }, "shapes": { "AutomaticStopTimeMinutes": { @@ -37,7 +37,7 @@ "ClientRequestToken": { "base": null, "refs": { - "CreateEnvironmentEC2Request$clientRequestToken": "A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.
For more information, see Client Tokens in the Amazon EC2 API Reference.
" + "CreateEnvironmentEC2Request$clientRequestToken": "A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no more than one time.
For more information, see Client Tokens in the Amazon EC2 API Reference.
" } }, "ConcurrentAccessException": { @@ -53,7 +53,7 @@ "ConnectionType": { "base": null, "refs": { - "CreateEnvironmentEC2Request$connectionType": "The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems Manager).
For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide.
", + "CreateEnvironmentEC2Request$connectionType": "The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon EC2 Systems Manager).
For more information, see Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager in the Cloud9 User Guide.
", "Environment$connectionType": "The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.
Information about an AWS Cloud9 development environment.
", + "base": "Information about an Cloud9 development environment.
", "refs": { "EnvironmentList$member": null } @@ -136,9 +136,9 @@ "EnvironmentArn": { "base": null, "refs": { - "ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.
", - "TagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.
", - "UntagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.
" + "ListTagsForResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags for.
", + "TagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags to.
", + "UntagResourceRequest$ResourceARN": "The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags from.
" } }, "EnvironmentDescription": { @@ -173,7 +173,7 @@ } }, "EnvironmentLifecycle": { - "base": "Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.
", + "base": "Information about the current creation or deletion lifecycle state of an Cloud9 development environment.
", "refs": { "Environment$lifecycle": "The state of the environment in its creation or deletion lifecycle.
" } @@ -191,7 +191,7 @@ } }, "EnvironmentMember": { - "base": "Information about an environment member for an AWS Cloud9 development environment.
", + "base": "Information about an environment member for an Cloud9 development environment.
", "refs": { "CreateEnvironmentMembershipResult$membership": "Information about the environment member that was added.
", "EnvironmentMembersList$member": null, @@ -207,7 +207,7 @@ "EnvironmentName": { "base": null, "refs": { - "CreateEnvironmentEC2Request$name": "The name of the environment to create.
This name is visible to other AWS IAM users in the same AWS account.
", + "CreateEnvironmentEC2Request$name": "The name of the environment to create.
This name is visible to other IAM users in the same Amazon Web Services account.
", "Environment$name": "The name of the environment.
", "UpdateEnvironmentRequest$name": "A replacement name for the environment.
" } @@ -232,7 +232,7 @@ "ImageId": { "base": null, "refs": { - "CreateEnvironmentEC2Request$imageId": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager (SSM) path.
The default AMI is used if the parameter isn't explicitly assigned a value in the request.
AMI aliases
Amazon Linux (default): amazonlinux-1-x86_64
Amazon Linux 2: amazonlinux-2-x86_64
Ubuntu 18.04: ubuntu-18.04-x86_64
SSM paths
Amazon Linux (default): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64
Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM) path.
The default AMI is used if the parameter isn't explicitly assigned a value in the request. Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you choose Amazon Linux 2, which includes long term support through 2023.
AMI aliases
Amazon Linux (default): amazonlinux-1-x86_64
Amazon Linux 2: amazonlinux-2-x86_64
Ubuntu 18.04: ubuntu-18.04-x86_64
SSM paths
Amazon Linux (default): resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64
Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64
Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64
Describes the status of AWS managed temporary credentials for the AWS Cloud9 environment. Available values are:
ENABLED_ON_CREATE
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
DISABLED_BY_OWNER
DISABLED_BY_COLLABORATOR
PENDING_REMOVAL_BY_COLLABORATOR
PENDING_REMOVAL_BY_OWNER
FAILED_REMOVAL_BY_COLLABORATOR
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:
ENABLED_ON_CREATE
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
DISABLED_BY_OWNER
DISABLED_BY_COLLABORATOR
PENDING_REMOVAL_BY_COLLABORATOR
PENDING_REMOVAL_BY_OWNER
FAILED_REMOVAL_BY_COLLABORATOR
ENABLED_BY_OWNER
DISABLED_BY_DEFAULT
The Amazon Resource Name (ARN) of the environment.
", "Environment$ownerArn": "The Amazon Resource Name (ARN) of the environment owner.
", "EnvironmentLifecycle$reason": "Any informational message about the lifecycle state of the environment.
", - "EnvironmentLifecycle$failureResource": "If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.
", - "EnvironmentMember$userId": "The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
", + "EnvironmentLifecycle$failureResource": "If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services resource.
", + "EnvironmentMember$userId": "The user ID in Identity and Access Management (IAM) of the environment member.
", "ListEnvironmentsRequest$nextToken": "During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
", "ListEnvironmentsResult$nextToken": "If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.
" } @@ -327,11 +327,11 @@ "SubnetId": { "base": null, "refs": { - "CreateEnvironmentEC2Request$subnetId": "The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
" + "CreateEnvironmentEC2Request$subnetId": "The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2 instance.
" } }, "Tag": { - "base": "Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
", + "base": "Metadata that is associated with Amazon Web Services resources. In particular, a name-value pair that can be associated with an Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by Amazon Web Services services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
", "refs": { "TagList$member": null } @@ -346,15 +346,15 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$TagKeys": "The tag names of the tags to remove from the given AWS Cloud9 development environment.
" + "UntagResourceRequest$TagKeys": "The tag names of the tags to remove from the given Cloud9 development environment.
" } }, "TagList": { "base": null, "refs": { - "CreateEnvironmentEC2Request$tags": "An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
", - "ListTagsForResourceResponse$Tags": "The list of tags associated with the AWS Cloud9 development environment.
", - "TagResourceRequest$Tags": "The list of tags to add to the given AWS Cloud9 development environment.
" + "CreateEnvironmentEC2Request$tags": "An array of key-value pairs that will be associated with the new Cloud9 development environment.
", + "ListTagsForResourceResponse$Tags": "The list of tags associated with the Cloud9 development environment.
", + "TagResourceRequest$Tags": "The list of tags to add to the given Cloud9 development environment.
" } }, "TagResourceRequest": { @@ -417,7 +417,7 @@ "UserArn": { "base": null, "refs": { - "CreateEnvironmentEC2Request$ownerArn": "The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.
", + "CreateEnvironmentEC2Request$ownerArn": "The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any IAM principal. If this value is not specified, the ARN defaults to this environment's creator.
", "CreateEnvironmentMembershipRequest$userArn": "The Amazon Resource Name (ARN) of the environment member you want to add.
", "DeleteEnvironmentMembershipRequest$userArn": "The Amazon Resource Name (ARN) of the environment member to delete from the environment.
", "DescribeEnvironmentMembershipsRequest$userArn": "The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.
", diff --git a/models/apis/cloud9/2017-09-23/examples-1.json b/models/apis/cloud9/2017-09-23/examples-1.json index bc428bdf05b..92cc8bb00f2 100644 --- a/models/apis/cloud9/2017-09-23/examples-1.json +++ b/models/apis/cloud9/2017-09-23/examples-1.json @@ -115,7 +115,7 @@ "output": { } }, - "description": "The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.", + "description": "The following example gets information about all of the environment members for the specified &AWS; Cloud9 development environment.", "id": "describeenvironmentmemberships1-1516823070453", "title": "DescribeEnvironmentMemberships1" }, @@ -142,7 +142,7 @@ "output": { } }, - "description": "The following example gets information about the owner of the specified AWS Cloud9 development environment.", + "description": "The following example gets information about the owner of the specified &AWS; Cloud9 development environment.", "id": "describeenvironmentmemberships2-1516823191355", "title": "DescribeEnvironmentMemberships2" }, @@ -174,7 +174,7 @@ "output": { } }, - "description": "The following example gets AWS Cloud9 development environment membership information for the specified user.", + "description": "The following example gets &AWS; Cloud9 development environment membership information for the specified user.", "id": "describeenvironmentmemberships3-1516823268793", "title": "DescribeEnvironmentMemberships3" } diff --git a/models/apis/cloudfront/2020-05-31/api-2.json b/models/apis/cloudfront/2020-05-31/api-2.json index 98413eb7791..136d971cfb0 100644 --- a/models/apis/cloudfront/2020-05-31/api-2.json +++ b/models/apis/cloudfront/2020-05-31/api-2.json @@ -4673,7 +4673,8 @@ "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", - "TLSv1.2_2019" + "TLSv1.2_2019", + "TLSv1.2_2021" ] }, "MissingBody":{ diff --git a/models/apis/cloudsearch/2013-01-01/api-2.json b/models/apis/cloudsearch/2013-01-01/api-2.json index 41d4ae63f62..de5fed0043f 100644 --- a/models/apis/cloudsearch/2013-01-01/api-2.json +++ b/models/apis/cloudsearch/2013-01-01/api-2.json @@ -42,7 +42,9 @@ "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ValidationException"} ] }, "DefineAnalysisScheme":{ @@ -1330,10 +1332,25 @@ "search.medium", "search.large", "search.xlarge", - "search.2xlarge" + "search.2xlarge", + "search.previousgeneration.small", + "search.previousgeneration.large", + "search.previousgeneration.xlarge", + "search.previousgeneration.2xlarge" ] }, "PolicyDocument":{"type":"string"}, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, "ResourceNotFoundException":{ "type":"structure", "members":{ diff --git a/models/apis/cloudsearch/2013-01-01/docs-2.json b/models/apis/cloudsearch/2013-01-01/docs-2.json index 1de25c814ad..cab0584c2db 100644 --- a/models/apis/cloudsearch/2013-01-01/docs-2.json +++ b/models/apis/cloudsearch/2013-01-01/docs-2.json @@ -733,6 +733,11 @@ "UpdateServiceAccessPoliciesRequest$AccessPolicies": "The access rules you want to configure. These rules replace any existing rules.
" } }, + "ResourceAlreadyExistsException": { + "base": "The request was rejected because it attempted to create a resource that already exists.
", + "refs": { + } + }, "ResourceNotFoundException": { "base": "The request was rejected because it attempted to reference a resource that does not exist.
", "refs": { diff --git a/models/apis/codeguru-reviewer/2019-09-19/api-2.json b/models/apis/codeguru-reviewer/2019-09-19/api-2.json index e555657d1c2..6c090d2c5ae 100644 --- a/models/apis/codeguru-reviewer/2019-09-19/api-2.json +++ b/models/apis/codeguru-reviewer/2019-09-19/api-2.json @@ -240,6 +240,17 @@ "error":{"httpStatusCode":403}, "exception":true }, + "AnalysisType":{ + "type":"string", + "enum":[ + "Security", + "CodeQuality" + ] + }, + "AnalysisTypes":{ + "type":"list", + "member":{"shape":"AnalysisType"} + }, "Arn":{ "type":"string", "max":1600, @@ -277,17 +288,42 @@ "max":64, "min":1 }, + "BranchDiffSourceCodeType":{ + "type":"structure", + "required":[ + "SourceBranchName", + "DestinationBranchName" + ], + "members":{ + "SourceBranchName":{"shape":"BranchName"}, + "DestinationBranchName":{"shape":"BranchName"} + } + }, "BranchName":{ "type":"string", "max":256, "min":1 }, + "BuildArtifactsObjectKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, "ClientRequestToken":{ "type":"string", "max":64, "min":1, "pattern":"^[\\w-]+$" }, + "CodeArtifacts":{ + "type":"structure", + "required":["SourceCodeArtifactsObjectKey"], + "members":{ + "SourceCodeArtifactsObjectKey":{"shape":"SourceCodeArtifactsObjectKey"}, + "BuildArtifactsObjectKey":{"shape":"BuildArtifactsObjectKey"} + } + }, "CodeCommitRepository":{ "type":"structure", "required":["Name"], @@ -311,7 +347,8 @@ "PullRequestId":{"shape":"PullRequestId"}, "SourceCodeType":{"shape":"SourceCodeType"}, "AssociationArn":{"shape":"AssociationArn"}, - "Metrics":{"shape":"Metrics"} + "Metrics":{"shape":"Metrics"}, + "AnalysisTypes":{"shape":"AnalysisTypes"} } }, "CodeReviewName":{ @@ -337,21 +374,24 @@ "LastUpdatedTimeStamp":{"shape":"TimeStamp"}, "Type":{"shape":"Type"}, "PullRequestId":{"shape":"PullRequestId"}, - "MetricsSummary":{"shape":"MetricsSummary"} + "MetricsSummary":{"shape":"MetricsSummary"}, + "SourceCodeType":{"shape":"SourceCodeType"} } }, "CodeReviewType":{ "type":"structure", "required":["RepositoryAnalysis"], "members":{ - "RepositoryAnalysis":{"shape":"RepositoryAnalysis"} + "RepositoryAnalysis":{"shape":"RepositoryAnalysis"}, + "AnalysisTypes":{"shape":"AnalysisTypes"} } }, "CommitDiffSourceCodeType":{ "type":"structure", "members":{ "SourceCommit":{"shape":"CommitId"}, - "DestinationCommit":{"shape":"CommitId"} + "DestinationCommit":{"shape":"CommitId"}, + "MergeBaseCommit":{"shape":"CommitId"} } }, "CommitId":{ @@ -487,6 +527,25 @@ ] }, "ErrorMessage":{"type":"string"}, + "EventInfo":{ + "type":"structure", + "members":{ + "Name":{"shape":"EventName"}, + "State":{"shape":"EventState"} + } + }, + "EventName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[ \\-A-Z_a-z]+$" + }, + "EventState":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[ \\-A-Z_a-z]+$" + }, "FilePath":{ "type":"string", "max":1024, @@ -767,7 +826,8 @@ "CodeCommit", "GitHub", "Bitbucket", - "GitHubEnterpriseServer" + "GitHubEnterpriseServer", + "S3Bucket" ] }, "ProviderTypes":{ @@ -812,6 +872,21 @@ "max":1, "min":0 }, + "RecommendationCategory":{ + "type":"string", + "enum":[ + "AWSBestPractices", + "AWSCloudFormationIssues", + "DuplicateCode", + "CodeMaintenanceIssues", + "ConcurrencyIssues", + "InputValidations", + "PythonBestPractices", + "JavaBestPractices", + "ResourceLeaks", + "SecurityIssues" + ] + }, "RecommendationFeedback":{ "type":"structure", "members":{ @@ -857,7 +932,8 @@ "RecommendationId":{"shape":"RecommendationId"}, "StartLine":{"shape":"LineNumber"}, "EndLine":{"shape":"LineNumber"}, - "Description":{"shape":"Text"} + "Description":{"shape":"Text"}, + "RecommendationCategory":{"shape":"RecommendationCategory"} } }, "Repository":{ @@ -865,14 +941,15 @@ "members":{ "CodeCommit":{"shape":"CodeCommitRepository"}, "Bitbucket":{"shape":"ThirdPartySourceRepository"}, - "GitHubEnterpriseServer":{"shape":"ThirdPartySourceRepository"} + "GitHubEnterpriseServer":{"shape":"ThirdPartySourceRepository"}, + "S3Bucket":{"shape":"S3Repository"} } }, "RepositoryAnalysis":{ "type":"structure", - "required":["RepositoryHead"], "members":{ - "RepositoryHead":{"shape":"RepositoryHeadSourceCodeType"} + "RepositoryHead":{"shape":"RepositoryHeadSourceCodeType"}, + "SourceCodeType":{"shape":"SourceCodeType"} } }, "RepositoryAssociation":{ @@ -888,7 +965,8 @@ "StateReason":{"shape":"StateReason"}, "LastUpdatedTimeStamp":{"shape":"TimeStamp"}, "CreatedTimeStamp":{"shape":"TimeStamp"}, - "KMSKeyDetails":{"shape":"KMSKeyDetails"} + "KMSKeyDetails":{"shape":"KMSKeyDetails"}, + "S3RepositoryDetails":{"shape":"S3RepositoryDetails"} } }, "RepositoryAssociationState":{ @@ -937,6 +1015,26 @@ "max":100, "min":1 }, + "RequestId":{ + "type":"string", + "max":64, + "min":1 + }, + "RequestMetadata":{ + "type":"structure", + "members":{ + "RequestId":{"shape":"RequestId"}, + "Requester":{"shape":"Requester"}, + "EventInfo":{"shape":"EventInfo"}, + "VendorName":{"shape":"VendorName"} + } + }, + "Requester":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -945,11 +1043,52 @@ "error":{"httpStatusCode":404}, "exception":true }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^\\S(.*\\S)?$" + }, + "S3BucketRepository":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"Name"}, + "Details":{"shape":"S3RepositoryDetails"} + } + }, + "S3Repository":{ + "type":"structure", + "required":[ + "Name", + "BucketName" + ], + "members":{ + "Name":{"shape":"Name"}, + "BucketName":{"shape":"S3BucketName"} + } + }, + "S3RepositoryDetails":{ + "type":"structure", + "members":{ + "BucketName":{"shape":"S3BucketName"}, + "CodeArtifacts":{"shape":"CodeArtifacts"} + } + }, + "SourceCodeArtifactsObjectKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, "SourceCodeType":{ "type":"structure", "members":{ "CommitDiff":{"shape":"CommitDiffSourceCodeType"}, - "RepositoryHead":{"shape":"RepositoryHeadSourceCodeType"} + "RepositoryHead":{"shape":"RepositoryHeadSourceCodeType"}, + "BranchDiff":{"shape":"BranchDiffSourceCodeType"}, + "S3BucketRepository":{"shape":"S3BucketRepository"}, + "RequestMetadata":{"shape":"RequestMetadata"} } }, "StateReason":{ @@ -1075,6 +1214,14 @@ }, "error":{"httpStatusCode":400}, "exception":true + }, + "VendorName":{ + "type":"string", + "enum":[ + "GitHub", + "GitLab", + "NativeS3" + ] } } } diff --git a/models/apis/codeguru-reviewer/2019-09-19/docs-2.json b/models/apis/codeguru-reviewer/2019-09-19/docs-2.json index d162ee947be..abbeb42997f 100644 --- a/models/apis/codeguru-reviewer/2019-09-19/docs-2.json +++ b/models/apis/codeguru-reviewer/2019-09-19/docs-2.json @@ -1,9 +1,9 @@ { "version": "2.0", - "service": "This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommendations to address them in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
", + "service": "This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
", "operations": { - "AssociateRepository": "Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.
If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide.
You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.
Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request so cannot be created using this method.
Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.
If you associate a CodeCommit or S3 repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide.
You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.
Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request.
Returns the metadata associated with the code review along with its status.
", "DescribeRecommendationFeedback": "Describes the customer feedback for a CodeGuru Reviewer recommendation.
", "DescribeRepositoryAssociation": " Returns a RepositoryAssociation object that contains information about the requested repository association.
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
The repository association ID.
" } }, + "BranchDiffSourceCodeType": { + "base": " A type of SourceCodeType that specifies a code diff between a source and destination branch in an associated repository.
A type of SourceCodeType that specifies a source branch name and a destination branch name in an associated repository.
The source branch for a diff in an associated repository.
", + "BranchDiffSourceCodeType$DestinationBranchName": "The destination branch for a diff in an associated repository.
", "RepositoryHeadSourceCodeType$BranchName": " The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch.
The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see Create code reviews with security analysis in the Amazon CodeGuru Reviewer User Guide.
" + } + }, "ClientRequestToken": { "base": null, "refs": { @@ -80,8 +107,14 @@ "CreateCodeReviewRequest$ClientRequestToken": "Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate code reviews if there are failures and retries.
" } }, + "CodeArtifacts": { + "base": "Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.
Source code artifacts are source code files in a Git repository that are compressed into a .zip file.
Build artifacts are .jar or .class files that are compressed in a .zip file.
A CodeArtifacts object. The CodeArtifacts object includes the S3 object key for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.
Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
", + "base": "Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
", "refs": { "Repository$CodeCommit": "Information about an AWS CodeCommit repository.
" } @@ -112,13 +145,13 @@ } }, "CodeReviewType": { - "base": "The type of a code review. There are two code review types:
PullRequest - A code review that is automatically triggered by a pull request on an associated repository. Because this type of code review is automatically generated, you cannot specify this code review type using CreateCodeReview .
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview .
The type of a code review. There are two code review types:
PullRequest - A code review that is automatically triggered by a pull request on an associated repository.
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview .
The type of code review to create. This is specified using a CodeReviewType object. You can create a code review only of type RepositoryAnalysis.
A type of SourceCodeType that specifies the commit diff for a pull request on an associated repository.
A type of SourceCodeType that specifies the commit diff for a pull request on an associated repository. The SourceCommit and DestinationCommit fields are required to do a pull request code review.
A SourceCodeType that specifies a commit diff created by a pull request on an associated repository.
The SHA of the source commit used to generate a commit diff.
", - "CommitDiffSourceCodeType$DestinationCommit": "The SHA of the destination commit used to generate a commit diff.
" + "CommitDiffSourceCodeType$SourceCommit": "The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review.
", + "CommitDiffSourceCodeType$DestinationCommit": "The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.
", + "CommitDiffSourceCodeType$MergeBaseCommit": "The SHA of the merge base of a commit.
" } }, "ConflictException": { @@ -211,6 +245,24 @@ "ValidationException$Message": null } }, + "EventInfo": { + "base": "Information about an event. The event might be a push, pull request, scheduled request, or another type of event.
", + "refs": { + "RequestMetadata$EventInfo": "Information about the event associated with a code review.
" + } + }, + "EventName": { + "base": null, + "refs": { + "EventInfo$Name": "The name of the event. The possible names are pull_request, workflow_dispatch, schedule, and push
The state of an event. The state might be open, closed, or another state.
" + } + }, "FilePath": { "base": null, "refs": { @@ -358,6 +410,8 @@ "RepositoryAssociation$Name": "The name of the repository.
", "RepositoryAssociationSummary$Name": "The name of the repository association.
", "RepositoryNames$member": null, + "S3BucketRepository$Name": " The name of the repository when the ProviderType is S3Bucket.
The name of the repository in the S3 bucket.
", "ThirdPartySourceRepository$Name": "The name of the third party source repository.
" } }, @@ -388,12 +442,12 @@ "Owner": { "base": null, "refs": { - "CodeReview$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
", - "CodeReviewSummary$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
", + "CodeReview$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID.
", + "CodeReviewSummary$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID.
", "Owners$member": null, - "RepositoryAssociation$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
", - "RepositoryAssociationSummary$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.
", - "ThirdPartySourceRepository$Owner": "The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.
" + "RepositoryAssociation$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID.
", + "RepositoryAssociationSummary$Owner": "The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or AWS account ID.
", + "ThirdPartySourceRepository$Owner": "The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, this can be the username or AWS account ID.
" } }, "Owners": { @@ -450,6 +504,12 @@ "RecommendationFeedbackSummary$Reactions": "List for storing reactions. Reactions are utf-8 text code for emojis.
" } }, + "RecommendationCategory": { + "base": null, + "refs": { + "RecommendationSummary$RecommendationCategory": "The type of a recommendation.
" + } + }, "RecommendationFeedback": { "base": "Information about the recommendation feedback.
", "refs": { @@ -556,15 +616,67 @@ "ListCodeReviewsRequest$RepositoryNames": "List of repository names for filtering that needs to be applied before displaying the result.
" } }, + "RequestId": { + "base": null, + "refs": { + "RequestMetadata$RequestId": "The ID of the request. This is required for a pull request code review.
" + } + }, + "RequestMetadata": { + "base": "Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
", + "refs": { + "SourceCodeType$RequestMetadata": "Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The RequestMetadaa field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request.
An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.
The resource specified in the request was not found.
", "refs": { } }, + "S3BucketName": { + "base": null, + "refs": { + "S3Repository$BucketName": "The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.
The name of the S3 bucket used for associating a new S3 repository. It must begin with codeguru-reviewer-.
Information about an associated repository in an S3 bucket. The associated repository contains a source code .zip file and a build artifacts .zip file that contains .jar or .class files.
", + "refs": { + "SourceCodeType$S3BucketRepository": " Information about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object. The S3RepositoryDetails object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. S3BucketRepository is required in SourceCodeType for S3BucketRepository based code reviews.
Information about a repository in an S3 bucket.
", + "refs": { + "Repository$S3Bucket": null + } + }, + "S3RepositoryDetails": { + "base": " Specifies the name of an S3 bucket and a CodeArtifacts object that contains the S3 object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.
An S3RepositoryDetails object that specifies the name of an S3 bucket and a CodeArtifacts object. The CodeArtifacts object includes the S3 object keys for a source code .zip file and for a build artifacts .zip file.
The S3 object key for a source code .zip file. This is required for all code reviews.
" + } + }, "SourceCodeType": { - "base": "Specifies the source code that is analyzed in a code review. A code review can analyze the source code that is specified using a pull request diff or a branch in an associated repository.
", + "base": "Specifies the source code that is analyzed in a code review.
", "refs": { - "CodeReview$SourceCodeType": "The type of the source code for the code review.
" + "CodeReview$SourceCodeType": "The type of the source code for the code review.
", + "CodeReviewSummary$SourceCodeType": null, + "RepositoryAnalysis$SourceCodeType": null } }, "StateReason": { @@ -683,6 +795,12 @@ "base": "The input fails to satisfy the specified constraints.
", "refs": { } + }, + "VendorName": { + "base": null, + "refs": { + "RequestMetadata$VendorName": "The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.
Amazon DocumentDB API documentation
", "operations": { "AddSourceIdentifierToSubscription": "Adds a source identifier to an existing event notification subscription.
", - "AddTagsToResource": "Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
", "CopyDBClusterParameterGroup": "Copies the specified cluster parameter group.
", - "CopyDBClusterSnapshot": "Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
Creates a new Amazon DocumentDB cluster.
", "CreateDBClusterParameterGroup": "Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
Creates a snapshot of a cluster.
", "CreateDBInstance": "Creates a new instance.
", - "CreateDBSubnetGroup": "Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
", + "CreateDBSubnetGroup": "Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
", "CreateEventSubscription": "Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
Creates an Amazon DocumentDB global cluster that can span multiple multiple AWS Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
", "DeleteDBClusterParameterGroup": "Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
", "DeleteDBClusterSnapshot": "Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available state to be deleted.
Deletes a previously provisioned instance.
", + "DeleteDBInstance": "Deletes a previously provisioned instance.
", "DeleteDBSubnetGroup": "Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
Deletes an Amazon DocumentDB event notification subscription.
", "DeleteGlobalCluster": "Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
", + "DescribeCertificates": "Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
", "DescribeDBClusterParameterGroups": "Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
Returns the detailed parameter list for a particular cluster parameter group.
", - "DescribeDBClusterSnapshotAttributes": "Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts.
Returns information about cluster snapshots. This API operation supports pagination.
", "DescribeDBClusters": "Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
Returns a list of the available engines.
", @@ -41,9 +41,9 @@ "ListTagsForResource": "Lists all tags on an Amazon DocumentDB resource.
", "ModifyDBCluster": "Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", "ModifyDBClusterParameterGroup": " Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
", - "ModifyDBSubnetGroup": "Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
", + "ModifyDBSubnetGroup": "Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
", "ModifyEventSubscription": "Modifies an existing Amazon DocumentDB event notification subscription.
", "ModifyGlobalCluster": "Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
", @@ -91,9 +91,9 @@ "AttributeValueList": { "base": null, "refs": { - "DBClusterSnapshotAttribute$AttributeValues": "The values for the manual cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any AWS account to copy or restore.
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account IDs. To make the manual cluster snapshot restorable by any AWS account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all AWS accounts.
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the cluster snapshot, set it to all . If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
The values for the manual cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.
A list of cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
Specifies whether the cluster snapshot is encrypted.
", "DBEngineVersion$SupportsLogExportsToCloudwatchLogs": "A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Indicates that minor version patches are applied automatically.
", + "DBInstance$AutoMinorVersionUpgrade": "Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
", "DBInstance$PubliclyAccessible": "Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
Specifies whether or not the instance is encrypted.
", "DBInstanceStatusInfo$Normal": "A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.
Default: false
Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.
Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.
Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.
Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.
Indicates that only the default version of the specified engine or engine and major version combination is returned.
", "EventSubscription$Enabled": "A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
", @@ -158,7 +158,7 @@ "CopyDBClusterSnapshotMessage$CopyTags": "Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
Specifies whether the cluster is encrypted.
", "CreateDBClusterMessage$DeletionProtection": "Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.
Default: true
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.
", "CreateGlobalClusterMessage$StorageEncrypted": "The storage encryption setting for the new global cluster.
", @@ -168,7 +168,7 @@ "GlobalCluster$StorageEncrypted": "The storage encryption setting for the global cluster.
", "GlobalCluster$DeletionProtection": "The deletion protection setting for the new global cluster.
", "ModifyDBClusterMessage$DeletionProtection": "Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Indicates that minor version upgrades are applied automatically to the instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
", "ModifyEventSubscriptionMessage$Enabled": " A Boolean value; set to true to activate the subscription.
Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
", "PendingModifiedValues$MultiAZ": "Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
", @@ -178,7 +178,7 @@ } }, "Certificate": { - "base": "A certificate authority (CA) certificate for an AWS account.
", + "base": "A certificate authority (CA) certificate for an account.
", "refs": { "CertificateList$member": null } @@ -186,7 +186,7 @@ "CertificateList": { "base": null, "refs": { - "CertificateMessage$Certificates": "A list of certificates for this AWS account.
" + "CertificateMessage$Certificates": "A list of certificates for this account.
" } }, "CertificateMessage": { @@ -382,7 +382,7 @@ } }, "DBClusterRole": { - "base": "Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.
", + "base": "Describes an Identity and Access Management (IAM) role that is associated with a cluster.
", "refs": { "DBClusterRoles$member": null } @@ -390,7 +390,7 @@ "DBClusterRoles": { "base": null, "refs": { - "DBCluster$AssociatedRoles": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the cluster. IAM roles that are associated with a cluster grant permission for the cluster to access other AWS services on your behalf.
" + "DBCluster$AssociatedRoles": "Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
" } }, "DBClusterSnapshot": { @@ -408,7 +408,7 @@ } }, "DBClusterSnapshotAttribute": { - "base": "Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other AWS accounts to restore a manual cluster snapshot.
", + "base": "Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other accounts to restore a manual cluster snapshot.
", "refs": { "DBClusterSnapshotAttributeList$member": null } @@ -1051,7 +1051,7 @@ } }, "KMSKeyNotAccessibleFault": { - "base": "An error occurred when accessing an AWS KMS key.
", + "base": "An error occurred when accessing an KMS key.
", "refs": { } }, @@ -1074,7 +1074,7 @@ "CreateDBClusterMessage$EnableCloudwatchLogsExports": "A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
", "DBCluster$EnabledCloudwatchLogsExports": "A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
", "DBEngineVersion$ExportableLogTypes": "The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
", - "DBInstance$EnabledCloudwatchLogsExports": "A list of log types that this instance is configured to export to Amazon CloudWatch Logs.
", + "DBInstance$EnabledCloudwatchLogsExports": "A list of log types that this instance is configured to export to CloudWatch Logs.
", "PendingCloudwatchLogsExports$LogTypesToEnable": "Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
", "PendingCloudwatchLogsExports$LogTypesToDisable": "Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
", "RestoreDBClusterFromSnapshotMessage$EnableCloudwatchLogsExports": "A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
", @@ -1388,23 +1388,23 @@ "Certificate$Thumbprint": "The thumbprint of the certificate.
", "Certificate$CertificateArn": "The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.
The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.
Constraints:
Must specify a valid cluster parameter group.
If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.
Constraints:
Must specify a valid cluster parameter group.
If the source cluster parameter group is in the same Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
If the source parameter group is in a different Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
The identifier for the copied cluster parameter group.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-param-group1
A description for the copied cluster parameter group.
", - "CopyDBClusterSnapshotMessage$SourceDBClusterSnapshotIdentifier": "The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
Constraints:
Must specify a valid system snapshot in the available state.
If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
Constraints:
Must specify a valid system snapshot in the available state.
If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.
Example: my-cluster-snapshot1
The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.
If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another AWS Region.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:
SourceRegion - The ID of the region that contains the snapshot to be copied.
SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.
To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.
If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:
SourceRegion - The ID of the region that contains the snapshot to be copied.
SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
The name of the cluster parameter group to associate with this cluster.
", "CreateDBClusterMessage$DBSubnetGroupName": "A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
The name of the database engine to be used for this cluster.
Valid values: docdb
The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
", + "CreateDBClusterMessage$EngineVersion": "The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
The name of the master user for the cluster.
Constraints:
Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).
Constraints: Must contain from 8 to 100 characters.
", - "CreateDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", - "CreateDBClusterMessage$KmsKeyId": "The AWS KMS key identifier for an encrypted cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
", + "CreateDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBClusterMessage$KmsKeyId": "The KMS key identifier for an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.
", "CreateDBClusterMessage$PreSignedUrl": "Not currently supported.
", "CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the cluster parameter group.
Constraints:
Must not match the name of an existing DBClusterParameterGroup.
This value is stored as a lowercase string.
The cluster parameter group family name.
", @@ -1414,14 +1414,14 @@ "CreateDBInstanceMessage$DBInstanceIdentifier": "The instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the instance; for example, db.r5.large.
The name of the database engine to be used for this instance.
Valid value: docdb
The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "CreateDBInstanceMessage$AvailabilityZone": "The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Region.
Example: us-east-1d
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", "CreateDBInstanceMessage$DBClusterIdentifier": "The identifier of the cluster that the instance will belong to.
", "CreateDBSubnetGroupMessage$DBSubnetGroupName": "The name for the subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
The description for the subnet group.
", "CreateEventSubscriptionMessage$SubscriptionName": "The name of the subscription.
Constraints: The name must be fewer than 255 characters.
", "CreateEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
", - "CreateEventSubscriptionMessage$SourceType": "The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-snapshot, db-cluster-snapshot
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot
The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.
", "CreateGlobalClusterMessage$Engine": "The name of the database engine to be used for this cluster.
", "CreateGlobalClusterMessage$EngineVersion": "The engine version of the global cluster.
", @@ -1440,8 +1440,8 @@ "DBCluster$PreferredMaintenanceWindow": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", "DBCluster$ReplicationSourceIdentifier": "Contains the identifier of the source cluster if this cluster is a secondary cluster.
", "DBCluster$HostedZoneId": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
", - "DBCluster$KmsKeyId": "If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster.
The AWS Region-unique, immutable identifier for the cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is accessed.
", + "DBCluster$KmsKeyId": "If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
", "DBCluster$DBClusterArn": "The Amazon Resource Name (ARN) for the cluster.
", "DBClusterMember$DBInstanceIdentifier": "Specifies the instance identifier for this member of the cluster.
", "DBClusterMember$DBClusterParameterGroupStatus": "Specifies the status of the cluster parameter group for this member of the DB cluster.
", @@ -1453,8 +1453,8 @@ "DBClusterParameterGroupDetails$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a cluster parameter group.
Constraints:
Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
This value is stored as a lowercase string.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
", - "DBClusterRole$Status": "Describes the state of association between the IAM role and the cluster. The Status property returns one of the following values:
ACTIVE - The IAM role ARN is associated with the cluster and can be used to access other AWS services on your behalf.
PENDING - The IAM role ARN is being associated with the DB cluster.
INVALID - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
", + "DBClusterRole$Status": "Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
Specifies the identifier for the cluster snapshot.
", "DBClusterSnapshot$DBClusterIdentifier": "Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
", "DBClusterSnapshot$Engine": "Specifies the name of the database engine.
", @@ -1463,10 +1463,10 @@ "DBClusterSnapshot$MasterUsername": "Provides the master user name for the cluster snapshot.
", "DBClusterSnapshot$EngineVersion": "Provides the version of the database engine for this cluster snapshot.
", "DBClusterSnapshot$SnapshotType": "Provides the type of the cluster snapshot.
", - "DBClusterSnapshot$KmsKeyId": "If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster snapshot.
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
The Amazon Resource Name (ARN) for the cluster snapshot.
", "DBClusterSnapshot$SourceDBClusterSnapshotArn": "If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
", - "DBClusterSnapshotAttribute$AttributeName": "The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual cluster snapshot.
The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.
The identifier of the cluster snapshot that the attributes apply to.
", "DBClusterSnapshotMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the database engine.
", @@ -1484,8 +1484,8 @@ "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", "DBInstance$EngineVersion": "Indicates the database engine version.
", "DBInstance$DBClusterIdentifier": "Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
", - "DBInstance$KmsKeyId": " If StorageEncrypted is true, the AWS KMS key identifier for the encrypted instance.
The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.
", + "DBInstance$KmsKeyId": " If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
", "DBInstance$CACertificateIdentifier": "The identifier of the CA certificate for this DB instance.
", "DBInstance$DBInstanceArn": "The Amazon Resource Name (ARN) for the instance.
", "DBInstanceMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier for the cluster snapshot to describe the attributes for.
", "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
If provided, must match the identifier of an existing DBCluster.
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If provided, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.
manual - Return all cluster snapshots that you have manually created for your AWS account.
shared - Return all manual cluster snapshots that have been shared to your AWS account.
public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your account.
manual - Return all cluster snapshots that you have manually created for your account.
shared - Return all manual cluster snapshots that have been shared to your account.
public - Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
Constraints:
If provided, must match an existing DBClusterIdentifier.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the cluster parameter group family to return the engine parameter information for.
", "DescribeEngineDefaultClusterParametersMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The type of source that is generating the events.
Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot
The type of source that is generating the events.
Valid values: db-instance, db-parameter-group, db-security-group
The name of the Amazon DocumentDB event notification subscription that you want to describe.
", "DescribeEventSubscriptionsMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is provided, SourceType must also be provided.
If the source type is DBInstance, a DBInstanceIdentifier must be provided.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) for the event.
", "EventCategoriesList$member": null, "EventCategoriesMap$SourceType": "The source type that the returned categories belong to.
", - "EventSubscription$CustomerAwsId": "The AWS customer account that is associated with the Amazon DocumentDB event notification subscription.
", + "EventSubscription$CustomerAwsId": "The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
", "EventSubscription$CustSubscriptionId": "The Amazon DocumentDB event notification subscription ID.
", "EventSubscription$SnsTopicArn": "The topic ARN of the Amazon DocumentDB event notification subscription.
", "EventSubscription$Status": "The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.
The name of the filter. Filter names are case sensitive.
", "FilterValueList$member": null, - "GlobalCluster$GlobalClusterResourceId": "The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
", + "GlobalCluster$GlobalClusterResourceId": "The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
", "GlobalCluster$GlobalClusterArn": "The Amazon Resource Name (ARN) for the global cluster.
", "GlobalCluster$Status": "Specifies the current state of this global cluster.
", "GlobalCluster$Engine": "The Amazon DocumentDB database engine used by the global cluster.
", @@ -1579,14 +1579,14 @@ "ModifyDBClusterMessage$NewDBClusterIdentifier": "The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
The name of the cluster parameter group to use for the cluster.
", "ModifyDBClusterMessage$MasterUserPassword": "The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).
Constraints: Must contain from 8 to 100 characters.
", - "ModifyDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", + "ModifyDBClusterMessage$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
", "ModifyDBClusterMessage$EngineVersion": "The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.
", "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the cluster parameter group to modify.
", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "The identifier for the cluster snapshot to modify the attributes for.
", - "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "The name of the cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this value to restore.
The name of the cluster snapshot attribute to modify.
To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.
The instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions.
If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting.
", + "ModifyDBInstanceMessage$DBInstanceClass": "The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.
If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting.
", "ModifyDBInstanceMessage$PreferredMaintenanceWindow": "The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
", "ModifyDBInstanceMessage$NewDBInstanceIdentifier": " The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Indicates the certificate that needs to be associated with the instance.
", @@ -1594,7 +1594,7 @@ "ModifyDBSubnetGroupMessage$DBSubnetGroupDescription": "The description for the subnet group.
", "ModifyEventSubscriptionMessage$SubscriptionName": "The name of the Amazon DocumentDB event notification subscription.
", "ModifyEventSubscriptionMessage$SnsTopicArn": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
", - "ModifyEventSubscriptionMessage$SourceType": "The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.
Valid values: db-instance, db-parameter-group, db-security-group
The engine type of an instance.
", "OrderableDBInstanceOption$EngineVersion": "The engine version of an instance.
", "OrderableDBInstanceOption$DBInstanceClass": "The instance class for an instance.
", @@ -1634,19 +1634,19 @@ "RestoreDBClusterFromSnapshotMessage$Engine": "The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
", "RestoreDBClusterFromSnapshotMessage$EngineVersion": "The version of the database engine to use for the new cluster.
", "RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName": "The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
The name of the new cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
The identifier of the source cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
Specifies the identifier of the subnet.
", "Subnet$SubnetStatus": "Specifies the status of the subnet.
", "SubnetIdentifierList$member": null, - "Tag$Key": "The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", - "Tag$Value": "The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", + "Tag$Key": "The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
The name of the upgrade target database engine.
", "UpgradeTarget$EngineVersion": "The version number of the upgrade target database engine.
", "UpgradeTarget$Description": "The version of the database engine that an instance can be upgraded to.
", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index fc3084946dc..2b801505816 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -25715,7 +25715,8 @@ "PoolTagSpecifications":{ "shape":"TagSpecificationList", "locationName":"PoolTagSpecification" - } + }, + "MultiRegion":{"shape":"Boolean"} } }, "ProvisionByoipCidrResult":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index bee31576a83..4b65a74db46 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -1890,6 +1890,7 @@ "PrivateIpAddressSpecification$Primary": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
", "ProvisionByoipCidrRequest$PubliclyAdvertisable": "(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
", "ProvisionByoipCidrRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Deletes a connection.
", "DeleteEventBus": "Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
", "DeletePartnerEventSource": "This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.
When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
", - "DeleteRule": "Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
Retrieves details about an API destination.
", "DescribeArchive": "Retrieves details about an archive.
", "DescribeConnection": "Retrieves details about a connection.
", @@ -43,13 +43,13 @@ "PutPartnerEvents": "This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
", "PutPermission": "Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as \"*\" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
", "PutRule": "Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
", - "PutTargets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Amazon API Gateway REST APIs
Redshift Clusters to invoke Data API ExecuteStatement on
Custom/SaaS HTTPS APIs via EventBridge API Destinations
Amazon SageMaker Model Building Pipelines
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
Amazon API Gateway REST API endpoints
API Gateway
AWS Batch job queue
CloudWatch Logs group
CodeBuild project
CodePineline
Amazon EC2 CreateSnapshot API call
Amazon EC2 RebootInstances API call
Amazon EC2 StopInstances API call
Amazon EC2 TerminateInstances API call
Amazon ECS tasks
Event bus in a different AWS account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Firehose delivery stream (Kinesis Data Firehose)
Inspector assessment template (Amazon Inspector)
Kinesis stream (Kinesis Data Stream)
AWS Lambda function
Redshift clusters (Data API statement execution)
Amazon SNS topic
Amazon SQS queues (includes FIFO queues
SSM Automation
SSM OpsItem
SSM Run Command
Step Functions state machines
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
", "TestEventPattern": "Tests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
", - "UntagResource": "Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
", + "UntagResource": "Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
", "UpdateApiDestination": "Updates an API destination.
", "UpdateArchive": "Updates the specified archive.
", "UpdateConnection": "Updates settings for a connection.
" @@ -277,6 +277,8 @@ "ConnectionHeaderParameter$IsValueSecret": "Specified whether the value is a secret.
", "ConnectionQueryStringParameter$IsValueSecret": "Specifies whether the value is secret.
", "DeleteRuleRequest$Force": "If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "EcsParameters$EnableExecuteCommand": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
", "RedshiftDataParameters$WithEvent": "Indicates whether to send an event back to EventBridge after the SQL statement runs.
", "RemovePermissionRequest$RemoveAllPermissions": "Specifies whether to remove all permissions.
", "RemoveTargetsRequest$Force": "If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
The short name of the capacity provider.
" + } + }, + "CapacityProviderStrategy": { + "base": null, + "refs": { + "EcsParameters$CapacityProviderStrategy": "The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
", + "refs": { + "CapacityProviderStrategy$member": null + } + }, + "CapacityProviderStrategyItemBase": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$base": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
" + } + }, + "CapacityProviderStrategyItemWeight": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$weight": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
" + } + }, "ConcurrentModificationException": { "base": "There is concurrent modification on a rule, target, archive, or replay.
", "refs": { @@ -745,7 +777,7 @@ } }, "EventBus": { - "base": "An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
", + "base": "An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from AWS services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
", "refs": { "EventBusList$member": null } @@ -1233,6 +1265,54 @@ "HttpParameters$PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
" } }, + "PlacementConstraint": { + "base": "An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "PlacementConstraints$member": null + } + }, + "PlacementConstraintExpression": { + "base": null, + "refs": { + "PlacementConstraint$expression": "A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
" + } + }, + "PlacementConstraints": { + "base": null, + "refs": { + "EcsParameters$PlacementConstraints": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + } + }, + "PlacementStrategies": { + "base": null, + "refs": { + "EcsParameters$PlacementStrategy": "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
" + } + }, + "PlacementStrategy": { + "base": "The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "PlacementStrategies$member": null + } + }, + "PlacementStrategyField": { + "base": null, + "refs": { + "PlacementStrategy$field": "The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
" + } + }, + "PlacementStrategyType": { + "base": null, + "refs": { + "PlacementStrategy$type": "The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + } + }, "PolicyLengthExceededException": { "base": "The event bus policy is too long. For more information, see the limits.
", "refs": { @@ -1244,6 +1324,12 @@ "PutPermissionRequest$Principal": "The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify \"*\" to permit any account to put events to your default event bus.
If you specify \"*\" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
" + } + }, "PutEventsRequest": { "base": null, "refs": { @@ -1381,6 +1467,12 @@ "RedshiftDataParameters$SecretManagerArn": "The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
" } }, + "ReferenceId": { + "base": null, + "refs": { + "EcsParameters$ReferenceId": "The reference ID to use for the task.
" + } + }, "RemovePermissionRequest": { "base": null, "refs": { @@ -1762,6 +1854,7 @@ "base": null, "refs": { "CreateEventBusRequest$Tags": "Tags to associate with the event bus.
", + "EcsParameters$Tags": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
", "ListTagsForResourceResponse$Tags": "The list of tag keys and values associated with the resource you specified
", "PutRuleRequest$Tags": "The list of key-value pairs to associate with the rule.
", "TagResourceRequest$Tags": "The list of key-value pairs to associate with the resource.
" diff --git a/models/apis/events/2015-10-07/api-2.json b/models/apis/events/2015-10-07/api-2.json index 0d923a70163..26fd8810bc7 100644 --- a/models/apis/events/2015-10-07/api-2.json +++ b/models/apis/events/2015-10-07/api-2.json @@ -924,6 +924,35 @@ "StateReason":{"shape":"ReplayStateReason"} } }, + "CapacityProvider":{ + "type":"string", + "max":255, + "min":1 + }, + "CapacityProviderStrategy":{ + "type":"list", + "member":{"shape":"CapacityProviderStrategyItem"}, + "max":6 + }, + "CapacityProviderStrategyItem":{ + "type":"structure", + "required":["capacityProvider"], + "members":{ + "capacityProvider":{"shape":"CapacityProvider"}, + "weight":{"shape":"CapacityProviderStrategyItemWeight"}, + "base":{"shape":"CapacityProviderStrategyItemBase"} + } + }, + "CapacityProviderStrategyItemBase":{ + "type":"integer", + "max":100000, + "min":0 + }, + "CapacityProviderStrategyItemWeight":{ + "type":"integer", + "max":1000, + "min":0 + }, "ConcurrentModificationException":{ "type":"structure", "members":{ @@ -1547,7 +1576,15 @@ "LaunchType":{"shape":"LaunchType"}, "NetworkConfiguration":{"shape":"NetworkConfiguration"}, "PlatformVersion":{"shape":"String"}, - "Group":{"shape":"String"} + "Group":{"shape":"String"}, + "CapacityProviderStrategy":{"shape":"CapacityProviderStrategy"}, + "EnableECSManagedTags":{"shape":"Boolean"}, + "EnableExecuteCommand":{"shape":"Boolean"}, + "PlacementConstraints":{"shape":"PlacementConstraints"}, + "PlacementStrategy":{"shape":"PlacementStrategies"}, + "PropagateTags":{"shape":"PropagateTags"}, + "ReferenceId":{"shape":"ReferenceId"}, + "Tags":{"shape":"TagList"} } }, "EnableRuleRequest":{ @@ -2006,6 +2043,53 @@ "type":"list", "member":{"shape":"PathParameter"} }, + "PlacementConstraint":{ + "type":"structure", + "members":{ + "type":{"shape":"PlacementConstraintType"}, + "expression":{"shape":"PlacementConstraintExpression"} + } + }, + "PlacementConstraintExpression":{ + "type":"string", + "max":2000 + }, + "PlacementConstraintType":{ + "type":"string", + "enum":[ + "distinctInstance", + "memberOf" + ] + }, + "PlacementConstraints":{ + "type":"list", + "member":{"shape":"PlacementConstraint"}, + "max":10 + }, + "PlacementStrategies":{ + "type":"list", + "member":{"shape":"PlacementStrategy"}, + "max":5 + }, + "PlacementStrategy":{ + "type":"structure", + "members":{ + "type":{"shape":"PlacementStrategyType"}, + "field":{"shape":"PlacementStrategyField"} + } + }, + "PlacementStrategyField":{ + "type":"string", + "max":255 + }, + "PlacementStrategyType":{ + "type":"string", + "enum":[ + "random", + "spread", + "binpack" + ] + }, "PolicyLengthExceededException":{ "type":"structure", "members":{ @@ -2018,6 +2102,10 @@ "min":1, "pattern":"(\\d{12}|\\*)" }, + "PropagateTags":{ + "type":"string", + "enum":["TASK_DEFINITION"] + }, "PutEventsRequest":{ "type":"structure", "required":["Entries"], @@ -2202,6 +2290,10 @@ "min":1, "pattern":"(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" }, + "ReferenceId":{ + "type":"string", + "max":1024 + }, "RemovePermissionRequest":{ "type":"structure", "members":{ diff --git a/models/apis/events/2015-10-07/docs-2.json b/models/apis/events/2015-10-07/docs-2.json index dde0423caa2..7b24c558c5b 100644 --- a/models/apis/events/2015-10-07/docs-2.json +++ b/models/apis/events/2015-10-07/docs-2.json @@ -16,7 +16,7 @@ "DeleteConnection": "Deletes a connection.
", "DeleteEventBus": "Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.
", "DeletePartnerEventSource": "This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.
When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
", - "DeleteRule": "Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
Retrieves details about an API destination.
", "DescribeArchive": "Retrieves details about an archive.
", "DescribeConnection": "Retrieves details about a connection.
", @@ -43,13 +43,13 @@ "PutPartnerEvents": "This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
", "PutPermission": "Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.
For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as \"*\" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
", "PutRule": "Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.
If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
", - "PutTargets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Amazon API Gateway REST APIs
Redshift Clusters to invoke Data API ExecuteStatement on
Custom/SaaS HTTPS APIs via EventBridge API Destinations
Amazon SageMaker Model Building Pipelines
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for Events:
Amazon API Gateway REST API endpoints
API Gateway
AWS Batch job queue
CloudWatch Logs group
CodeBuild project
CodePineline
Amazon EC2 CreateSnapshot API call
Amazon EC2 RebootInstances API call
Amazon EC2 StopInstances API call
Amazon EC2 TerminateInstances API call
Amazon ECS tasks
Event bus in a different AWS account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Firehose delivery stream (Kinesis Data Firehose)
Inspector assessment template (Amazon Inspector)
Kinesis stream (Kinesis Data Stream)
AWS Lambda function
Redshift clusters (Data API statement execution)
Amazon SNS topic
Amazon SQS queues (includes FIFO queues
SSM Automation
SSM OpsItem
SSM Run Command
Step Functions state machines
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.
If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
", "TestEventPattern": "Tests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
", - "UntagResource": "Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
", + "UntagResource": "Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
", "UpdateApiDestination": "Updates an API destination.
", "UpdateArchive": "Updates the specified archive.
", "UpdateConnection": "Updates settings for a connection.
" @@ -277,6 +277,8 @@ "ConnectionHeaderParameter$IsValueSecret": "Specified whether the value is a secret.
", "ConnectionQueryStringParameter$IsValueSecret": "Specifies whether the value is secret.
", "DeleteRuleRequest$Force": "If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "EcsParameters$EnableExecuteCommand": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
", "RedshiftDataParameters$WithEvent": "Indicates whether to send an event back to EventBridge after the SQL statement runs.
", "RemovePermissionRequest$RemoveAllPermissions": "Specifies whether to remove all permissions.
", "RemoveTargetsRequest$Force": "If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
The short name of the capacity provider.
" + } + }, + "CapacityProviderStrategy": { + "base": null, + "refs": { + "EcsParameters$CapacityProviderStrategy": "The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
", + "refs": { + "CapacityProviderStrategy$member": null + } + }, + "CapacityProviderStrategyItemBase": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$base": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
" + } + }, + "CapacityProviderStrategyItemWeight": { + "base": null, + "refs": { + "CapacityProviderStrategyItem$weight": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
" + } + }, "ConcurrentModificationException": { "base": "There is concurrent modification on a rule, target, archive, or replay.
", "refs": { @@ -745,7 +777,7 @@ } }, "EventBus": { - "base": "An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
", + "base": "An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from AWS services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
", "refs": { "EventBusList$member": null } @@ -1233,6 +1265,54 @@ "HttpParameters$PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").
" } }, + "PlacementConstraint": { + "base": "An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "PlacementConstraints$member": null + } + }, + "PlacementConstraintExpression": { + "base": null, + "refs": { + "PlacementConstraint$expression": "A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
" + } + }, + "PlacementConstraints": { + "base": null, + "refs": { + "EcsParameters$PlacementConstraints": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
" + } + }, + "PlacementStrategies": { + "base": null, + "refs": { + "EcsParameters$PlacementStrategy": "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
" + } + }, + "PlacementStrategy": { + "base": "The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
", + "refs": { + "PlacementStrategies$member": null + } + }, + "PlacementStrategyField": { + "base": null, + "refs": { + "PlacementStrategy$field": "The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
" + } + }, + "PlacementStrategyType": { + "base": null, + "refs": { + "PlacementStrategy$type": "The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
" + } + }, "PolicyLengthExceededException": { "base": "The event bus policy is too long. For more information, see the limits.
", "refs": { @@ -1244,6 +1324,12 @@ "PutPermissionRequest$Principal": "The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify \"*\" to permit any account to put events to your default event bus.
If you specify \"*\" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
" + } + }, "PutEventsRequest": { "base": null, "refs": { @@ -1381,6 +1467,12 @@ "RedshiftDataParameters$SecretManagerArn": "The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
" } }, + "ReferenceId": { + "base": null, + "refs": { + "EcsParameters$ReferenceId": "The reference ID to use for the task.
" + } + }, "RemovePermissionRequest": { "base": null, "refs": { @@ -1762,6 +1854,7 @@ "base": null, "refs": { "CreateEventBusRequest$Tags": "Tags to associate with the event bus.
", + "EcsParameters$Tags": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
", "ListTagsForResourceResponse$Tags": "The list of tag keys and values associated with the resource you specified
", "PutRuleRequest$Tags": "The list of key-value pairs to associate with the rule.
", "TagResourceRequest$Tags": "The list of key-value pairs to associate with the resource.
" diff --git a/models/apis/license-manager/2018-08-01/api-2.json b/models/apis/license-manager/2018-08-01/api-2.json index 60607bb9631..afaf0a0ef28 100644 --- a/models/apis/license-manager/2018-08-01/api-2.json +++ b/models/apis/license-manager/2018-08-01/api-2.json @@ -40,6 +40,7 @@ "output":{"shape":"CheckInLicenseResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AuthorizationException"}, @@ -58,6 +59,7 @@ "output":{"shape":"CheckoutBorrowLicenseResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NoEntitlementsAllowedException"}, {"shape":"EntitlementNotAllowedException"}, @@ -79,6 +81,7 @@ "output":{"shape":"CheckoutLicenseResponse"}, "errors":[ {"shape":"ValidationException"}, + {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NoEntitlementsAllowedException"}, {"shape":"UnsupportedDigitalSignatureMethodException"}, @@ -966,8 +969,8 @@ }, "ClientToken":{ "type":"string", - "max":64, - "pattern":"[a-zA-Z0-9]*" + "max":2048, + "pattern":"\\S+" }, "ConflictException":{ "type":"structure", @@ -1006,7 +1009,7 @@ "AllowedOperations" ], "members":{ - "ClientToken":{"shape":"String"}, + "ClientToken":{"shape":"ClientToken"}, "GrantName":{"shape":"String"}, "LicenseArn":{"shape":"Arn"}, "Principals":{"shape":"PrincipalArnList"}, @@ -1029,11 +1032,12 @@ "GrantArn" ], "members":{ - "ClientToken":{"shape":"String"}, + "ClientToken":{"shape":"ClientToken"}, "GrantArn":{"shape":"Arn"}, "GrantName":{"shape":"String"}, "AllowedOperations":{"shape":"AllowedOperationList"}, "Status":{"shape":"GrantStatus"}, + "StatusReason":{"shape":"StatusReasonMessage"}, "SourceVersion":{"shape":"String"} } }, @@ -1119,7 +1123,7 @@ "Beneficiary":{"shape":"String"}, "ConsumptionConfiguration":{"shape":"ConsumptionConfiguration"}, "LicenseMetadata":{"shape":"MetadataList"}, - "ClientToken":{"shape":"String"} + "ClientToken":{"shape":"ClientToken"} } }, "CreateLicenseResponse":{ @@ -1155,7 +1159,7 @@ "Entitlements":{"shape":"EntitlementList"}, "ConsumptionConfiguration":{"shape":"ConsumptionConfiguration"}, "Status":{"shape":"LicenseStatus"}, - "ClientToken":{"shape":"String"}, + "ClientToken":{"shape":"ClientToken"}, "SourceVersion":{"shape":"String"} } }, @@ -1178,7 +1182,7 @@ "RoleArns":{"shape":"ArnList"}, "ExpirationInDays":{"shape":"Integer"}, "TokenProperties":{"shape":"MaxSize3StringList"}, - "ClientToken":{"shape":"IdempotencyToken"} + "ClientToken":{"shape":"ClientToken"} } }, "CreateTokenResponse":{ @@ -1206,6 +1210,7 @@ ], "members":{ "GrantArn":{"shape":"Arn"}, + "StatusReason":{"shape":"StatusReasonMessage"}, "Version":{"shape":"String"} } }, @@ -1583,7 +1588,7 @@ "GranteePrincipalArn":{"shape":"Arn"}, "HomeRegion":{"shape":"String"}, "GrantStatus":{"shape":"GrantStatus"}, - "StatusReason":{"shape":"String"}, + "StatusReason":{"shape":"StatusReasonMessage"}, "Version":{"shape":"String"}, "GrantedOperations":{"shape":"AllowedOperationList"} } @@ -1602,7 +1607,8 @@ "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", - "DISABLED" + "DISABLED", + "WORKFLOW_COMPLETED" ] }, "GrantedLicense":{ @@ -1634,11 +1640,6 @@ "max":50, "pattern":"^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[ 0-3]|[0-1][0-9]):[0-5][0-9])+$" }, - "IdempotencyToken":{ - "type":"string", - "max":60, - "pattern":"\\S+" - }, "Integer":{"type":"integer"}, "InvalidParameterValueException":{ "type":"structure", @@ -2174,6 +2175,7 @@ "type":"structure", "members":{ "ReceivedStatus":{"shape":"ReceivedStatus"}, + "ReceivedStatusReason":{"shape":"StatusReasonMessage"}, "AllowedOperations":{"shape":"AllowedOperationList"} } }, @@ -2186,7 +2188,8 @@ "ACTIVE", "FAILED_WORKFLOW", "DELETED", - "DISABLED" + "DISABLED", + "WORKFLOW_COMPLETED" ] }, "RedirectException":{ @@ -2338,6 +2341,11 @@ "type":"string", "min":4096 }, + "StatusReasonMessage":{ + "type":"string", + "max":400, + "pattern":"[\\s\\S]+" + }, "String":{"type":"string"}, "StringList":{ "type":"list", diff --git a/models/apis/license-manager/2018-08-01/docs-2.json b/models/apis/license-manager/2018-08-01/docs-2.json index 771b4909b81..dd77022e654 100644 --- a/models/apis/license-manager/2018-08-01/docs-2.json +++ b/models/apis/license-manager/2018-08-01/docs-2.json @@ -243,7 +243,12 @@ "base": null, "refs": { "CheckoutBorrowLicenseRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "CheckoutLicenseRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" + "CheckoutLicenseRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateGrantRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateGrantVersionRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateLicenseRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateLicenseVersionRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateTokenRequest$ClientToken": "Idempotency token, valid for 10 minutes.
" } }, "ConflictException": { @@ -664,12 +669,6 @@ "TokenData$ExpirationTime": "Token expiration time, in ISO8601-UTC format.
" } }, - "IdempotencyToken": { - "base": null, - "refs": { - "CreateTokenRequest$ClientToken": "Idempotency token, valid for 10 minutes.
" - } - }, "Integer": { "base": null, "refs": { @@ -1257,6 +1256,15 @@ "CheckoutLicenseResponse$SignedToken": "Signed token.
" } }, + "StatusReasonMessage": { + "base": null, + "refs": { + "CreateGrantVersionRequest$StatusReason": null, + "DeleteGrantRequest$StatusReason": null, + "Grant$StatusReason": "Grant status reason.
", + "ReceivedMetadata$ReceivedStatusReason": null + } + }, "String": { "base": null, "refs": { @@ -1272,11 +1280,9 @@ "CheckoutLicenseRequest$NodeId": "Node ID.
", "CheckoutLicenseResponse$LicenseConsumptionToken": "License consumption token.
", "CheckoutLicenseResponse$NodeId": "Node ID.
", - "CreateGrantRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateGrantRequest$GrantName": "Grant name.
", "CreateGrantRequest$HomeRegion": "Home Region of the grant.
", "CreateGrantResponse$Version": "Grant version.
", - "CreateGrantVersionRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateGrantVersionRequest$GrantName": "Grant name.
", "CreateGrantVersionRequest$SourceVersion": "Current version of the grant.
", "CreateGrantVersionResponse$Version": "New version of the grant.
", @@ -1290,12 +1296,10 @@ "CreateLicenseRequest$ProductSKU": "Product SKU.
", "CreateLicenseRequest$HomeRegion": "Home Region for the license.
", "CreateLicenseRequest$Beneficiary": "License beneficiary.
", - "CreateLicenseRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateLicenseResponse$Version": "License version.
", "CreateLicenseVersionRequest$LicenseName": "License name.
", "CreateLicenseVersionRequest$ProductName": "Product name.
", "CreateLicenseVersionRequest$HomeRegion": "Home Region of the license.
", - "CreateLicenseVersionRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateLicenseVersionRequest$SourceVersion": "Current version of the license.
", "CreateLicenseVersionResponse$Version": "New version of the license.
", "CreateTokenResponse$TokenId": "Token ID.
", @@ -1330,7 +1334,6 @@ "GetServiceSettingsResponse$LicenseManagerResourceShareArn": "Amazon Resource Name (ARN) of the AWS resource share. The License Manager management account provides member accounts with access to this share.
", "Grant$GrantName": "Grant name.
", "Grant$HomeRegion": "Home Region of the grant.
", - "Grant$StatusReason": "Grant status reason.
", "Grant$Version": "Grant version.
", "GrantedLicense$LicenseName": "License name.
", "GrantedLicense$ProductName": "Product name.
", diff --git a/models/apis/mediatailor/2018-04-23/api-2.json b/models/apis/mediatailor/2018-04-23/api-2.json index ced25411e27..8a3556cbd34 100644 --- a/models/apis/mediatailor/2018-04-23/api-2.json +++ b/models/apis/mediatailor/2018-04-23/api-2.json @@ -1825,6 +1825,23 @@ }, "type": "list" }, + "ScheduleAdBreak": { + "members": { + "ApproximateDurationSeconds": { + "shape": "__long" + }, + "ApproximateStartTime": { + "shape": "__timestampUnix" + }, + "SourceLocationName": { + "shape": "__string" + }, + "VodSourceName": { + "shape": "__string" + } + }, + "type": "structure" + }, "ScheduleConfiguration": { "members": { "Transition": { @@ -1853,6 +1870,9 @@ "ProgramName": { "shape": "__string" }, + "ScheduleAdBreaks": { + "shape": "__listOfScheduleAdBreak" + }, "SourceLocationName": { "shape": "__string" }, @@ -2253,6 +2273,12 @@ }, "type": "list" }, + "__listOfScheduleAdBreak": { + "member": { + "shape": "ScheduleAdBreak" + }, + "type": "list" + }, "__listOfScheduleEntry": { "member": { "shape": "ScheduleEntry" @@ -2297,4 +2323,4 @@ "type": "timestamp" } } -} +} \ No newline at end of file diff --git a/models/apis/mediatailor/2018-04-23/docs-2.json b/models/apis/mediatailor/2018-04-23/docs-2.json index 81a93973ab9..1d3aec42142 100644 --- a/models/apis/mediatailor/2018-04-23/docs-2.json +++ b/models/apis/mediatailor/2018-04-23/docs-2.json @@ -361,6 +361,12 @@ "DescribeChannelResponse$Outputs": "The channel's output properties.
" } }, + "ScheduleAdBreak": { + "base": "The schedule's ad break properties.
", + "refs": { + "__listOfScheduleAdBreak$member": null + } + }, "ScheduleConfiguration": { "base": "Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
", "refs": { @@ -479,6 +485,12 @@ "ListPlaybackConfigurationsResponse$Items": "Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
" } }, + "__listOfScheduleAdBreak": { + "base": null, + "refs": { + "ScheduleEntry$ScheduleAdBreaks": "The schedule's ad break properties.
" + } + }, "__listOfScheduleEntry": { "base": null, "refs": { @@ -501,6 +513,7 @@ "base": null, "refs": { "AdBreak$OffsetMillis": "How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
", + "ScheduleAdBreak$ApproximateDurationSeconds": "The approximate duration of the ad break, in seconds.
", "ScheduleEntry$ApproximateDurationSeconds": "The approximate duration of this program, in seconds.
" } }, @@ -594,6 +607,8 @@ "ResponseOutputItem$ManifestName": "The name of the manifest for the channel that will appear in the channel output's playback URL.
", "ResponseOutputItem$PlaybackUrl": "The URL used for playback by content players.
", "ResponseOutputItem$SourceGroup": "A string used to associate a package configuration source group with a channel output.
", + "ScheduleAdBreak$SourceLocationName": "The name of the source location containing the VOD source used for the ad break.
", + "ScheduleAdBreak$VodSourceName": "The name of the VOD source used for the ad break.
", "ScheduleEntry$Arn": "The ARN of the program.
", "ScheduleEntry$ChannelName": "The name of the channel that uses this schedule.
", "ScheduleEntry$ProgramName": "The name of the program.
", @@ -626,6 +641,7 @@ "DescribeSourceLocationResponse$LastModifiedTime": "The timestamp that indicates when the source location was last modified.
", "DescribeVodSourceResponse$CreationTime": "The timestamp that indicates when the VOD source was created.
", "DescribeVodSourceResponse$LastModifiedTime": "The ARN for the VOD source.
", + "ScheduleAdBreak$ApproximateStartTime": "The approximate time that the ad will start playing.
", "ScheduleEntry$ApproximateStartTime": "The approximate time that the program will start playing.
", "SourceLocation$CreationTime": "The timestamp that indicates when the source location was created.
", "SourceLocation$LastModifiedTime": "The timestamp that indicates when the source location was last modified.
", @@ -634,4 +650,4 @@ } } } -} +} \ No newline at end of file diff --git a/models/apis/mediatailor/2018-04-23/paginators-1.json b/models/apis/mediatailor/2018-04-23/paginators-1.json index 996f59c3f88..9ed2d8a4d88 100644 --- a/models/apis/mediatailor/2018-04-23/paginators-1.json +++ b/models/apis/mediatailor/2018-04-23/paginators-1.json @@ -31,4 +31,4 @@ "result_key": "Items" } } -} +} \ No newline at end of file diff --git a/models/apis/quicksight/2018-04-01/api-2.json b/models/apis/quicksight/2018-04-01/api-2.json index a4b9cf44d27..b332dd6b7d8 100644 --- a/models/apis/quicksight/2018-04-01/api-2.json +++ b/models/apis/quicksight/2018-04-01/api-2.json @@ -121,6 +121,45 @@ {"shape":"InternalFailureException"} ] }, + "CreateFolder":{ + "name":"CreateFolder", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}" + }, + "input":{"shape":"CreateFolderRequest"}, + "output":{"shape":"CreateFolderResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ConflictException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ] + }, + "CreateFolderMembership":{ + "name":"CreateFolderMembership", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}" + }, + "input":{"shape":"CreateFolderMembershipRequest"}, + "output":{"shape":"CreateFolderMembershipResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "CreateGroup":{ "name":"CreateGroup", "http":{ @@ -376,6 +415,42 @@ {"shape":"InternalFailureException"} ] }, + "DeleteFolder":{ + "name":"DeleteFolder", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}" + }, + "input":{"shape":"DeleteFolderRequest"}, + "output":{"shape":"DeleteFolderResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "DeleteFolderMembership":{ + "name":"DeleteFolderMembership", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}" + }, + "input":{"shape":"DeleteFolderMembershipRequest"}, + "output":{"shape":"DeleteFolderMembershipResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ @@ -717,6 +792,57 @@ {"shape":"InternalFailureException"} ] }, + "DescribeFolder":{ + "name":"DescribeFolder", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}" + }, + "input":{"shape":"DescribeFolderRequest"}, + "output":{"shape":"DescribeFolderResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "DescribeFolderPermissions":{ + "name":"DescribeFolderPermissions", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/permissions" + }, + "input":{"shape":"DescribeFolderPermissionsRequest"}, + "output":{"shape":"DescribeFolderPermissionsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "DescribeFolderResolvedPermissions":{ + "name":"DescribeFolderResolvedPermissions", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions" + }, + "input":{"shape":"DescribeFolderResolvedPermissionsRequest"}, + "output":{"shape":"DescribeFolderResolvedPermissionsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "DescribeGroup":{ "name":"DescribeGroup", "http":{ @@ -1029,6 +1155,42 @@ {"shape":"InternalFailureException"} ] }, + "ListFolderMembers":{ + "name":"ListFolderMembers", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members" + }, + "input":{"shape":"ListFolderMembersRequest"}, + "output":{"shape":"ListFolderMembersResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "ListFolders":{ + "name":"ListFolders", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/folders" + }, + "input":{"shape":"ListFoldersRequest"}, + "output":{"shape":"ListFoldersResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "ListGroupMemberships":{ "name":"ListGroupMemberships", "http":{ @@ -1367,6 +1529,24 @@ {"shape":"InternalFailureException"} ] }, + "SearchFolders":{ + "name":"SearchFolders", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/search/folders" + }, + "input":{"shape":"SearchFoldersRequest"}, + "output":{"shape":"SearchFoldersResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -1591,6 +1771,43 @@ {"shape":"InternalFailureException"} ] }, + "UpdateFolder":{ + "name":"UpdateFolder", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}" + }, + "input":{"shape":"UpdateFolderRequest"}, + "output":{"shape":"UpdateFolderResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "UpdateFolderPermissions":{ + "name":"UpdateFolderPermissions", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/permissions" + }, + "input":{"shape":"UpdateFolderPermissionsRequest"}, + "output":{"shape":"UpdateFolderPermissionsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "UpdateGroup":{ "name":"UpdateGroup", "http":{ @@ -2414,6 +2631,81 @@ } } }, + "CreateFolderMembershipRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId", + "MemberId", + "MemberType" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "MemberId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"MemberId" + }, + "MemberType":{ + "shape":"MemberType", + "location":"uri", + "locationName":"MemberType" + } + } + }, + "CreateFolderMembershipResponse":{ + "type":"structure", + "members":{ + "Status":{"shape":"StatusCode"}, + "FolderMember":{"shape":"FolderMember"}, + "RequestId":{"shape":"String"} + } + }, + "CreateFolderRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "Name":{"shape":"FolderName"}, + "FolderType":{"shape":"FolderType"}, + "ParentFolderArn":{"shape":"Arn"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateFolderResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Arn":{"shape":"Arn"}, + "FolderId":{"shape":"RestrictiveResourceId"}, + "RequestId":{"shape":"String"} + } + }, "CreateGroupMembershipRequest":{ "type":"structure", "required":[ @@ -3345,6 +3637,75 @@ } } }, + "DeleteFolderMembershipRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId", + "MemberId", + "MemberType" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "MemberId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"MemberId" + }, + "MemberType":{ + "shape":"MemberType", + "location":"uri", + "locationName":"MemberType" + } + } + }, + "DeleteFolderMembershipResponse":{ + "type":"structure", + "members":{ + "Status":{"shape":"StatusCode"}, + "RequestId":{"shape":"String"} + } + }, + "DeleteFolderRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + } + } + }, + "DeleteFolderResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Arn":{"shape":"Arn"}, + "FolderId":{"shape":"RestrictiveResourceId"}, + "RequestId":{"shape":"String"} + } + }, "DeleteGroupMembershipRequest":{ "type":"structure", "required":[ @@ -3932,11 +4293,103 @@ } } }, - "DescribeDataSetRequest":{ + "DescribeDataSetRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DataSetId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DataSetId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"DataSetId" + } + } + }, + "DescribeDataSetResponse":{ + "type":"structure", + "members":{ + "DataSet":{"shape":"DataSet"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, + "DescribeDataSourcePermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DataSourceId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DataSourceId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"DataSourceId" + } + } + }, + "DescribeDataSourcePermissionsResponse":{ + "type":"structure", + "members":{ + "DataSourceArn":{"shape":"Arn"}, + "DataSourceId":{"shape":"ResourceId"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, + "DescribeDataSourceRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DataSourceId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DataSourceId":{ + "shape":"ResourceId", + "location":"uri", + "locationName":"DataSourceId" + } + } + }, + "DescribeDataSourceResponse":{ + "type":"structure", + "members":{ + "DataSource":{"shape":"DataSource"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, + "DescribeFolderPermissionsRequest":{ "type":"structure", "required":[ "AwsAccountId", - "DataSetId" + "FolderId" ], "members":{ "AwsAccountId":{ @@ -3944,29 +4397,31 @@ "location":"uri", "locationName":"AwsAccountId" }, - "DataSetId":{ - "shape":"ResourceId", + "FolderId":{ + "shape":"RestrictiveResourceId", "location":"uri", - "locationName":"DataSetId" + "locationName":"FolderId" } } }, - "DescribeDataSetResponse":{ + "DescribeFolderPermissionsResponse":{ "type":"structure", "members":{ - "DataSet":{"shape":"DataSet"}, - "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" - } + }, + "FolderId":{"shape":"RestrictiveResourceId"}, + "Arn":{"shape":"Arn"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "RequestId":{"shape":"String"} } }, - "DescribeDataSourcePermissionsRequest":{ + "DescribeFolderRequest":{ "type":"structure", "required":[ "AwsAccountId", - "DataSourceId" + "FolderId" ], "members":{ "AwsAccountId":{ @@ -3974,31 +4429,18 @@ "location":"uri", "locationName":"AwsAccountId" }, - "DataSourceId":{ - "shape":"ResourceId", + "FolderId":{ + "shape":"RestrictiveResourceId", "location":"uri", - "locationName":"DataSourceId" - } - } - }, - "DescribeDataSourcePermissionsResponse":{ - "type":"structure", - "members":{ - "DataSourceArn":{"shape":"Arn"}, - "DataSourceId":{"shape":"ResourceId"}, - "Permissions":{"shape":"ResourcePermissionList"}, - "RequestId":{"shape":"String"}, - "Status":{ - "shape":"StatusCode", - "location":"statusCode" + "locationName":"FolderId" } } }, - "DescribeDataSourceRequest":{ + "DescribeFolderResolvedPermissionsRequest":{ "type":"structure", "required":[ "AwsAccountId", - "DataSourceId" + "FolderId" ], "members":{ "AwsAccountId":{ @@ -4006,22 +4448,35 @@ "location":"uri", "locationName":"AwsAccountId" }, - "DataSourceId":{ - "shape":"ResourceId", + "FolderId":{ + "shape":"RestrictiveResourceId", "location":"uri", - "locationName":"DataSourceId" + "locationName":"FolderId" } } }, - "DescribeDataSourceResponse":{ + "DescribeFolderResolvedPermissionsResponse":{ "type":"structure", "members":{ - "DataSource":{"shape":"DataSource"}, - "RequestId":{"shape":"String"}, "Status":{ "shape":"StatusCode", "location":"statusCode" - } + }, + "FolderId":{"shape":"RestrictiveResourceId"}, + "Arn":{"shape":"Arn"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "RequestId":{"shape":"String"} + } + }, + "DescribeFolderResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Folder":{"shape":"Folder"}, + "RequestId":{"shape":"String"} } }, "DescribeGroupRequest":{ @@ -4532,11 +4987,77 @@ "type":"string", "enum":["StringEquals"] }, + "Folder":{ + "type":"structure", + "members":{ + "FolderId":{"shape":"RestrictiveResourceId"}, + "Arn":{"shape":"Arn"}, + "Name":{"shape":"FolderName"}, + "FolderType":{"shape":"FolderType"}, + "FolderPath":{"shape":"Path"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"} + } + }, "FolderColumnList":{ "type":"list", "member":{"shape":"String"}, "max":5000 }, + "FolderFilterAttribute":{ + "type":"string", + "enum":["PARENT_FOLDER_ARN"] + }, + "FolderMember":{ + "type":"structure", + "members":{ + "MemberId":{"shape":"RestrictiveResourceId"}, + "MemberType":{"shape":"MemberType"} + } + }, + "FolderMemberList":{ + "type":"list", + "member":{"shape":"MemberIdArnPair"}, + "max":100 + }, + "FolderName":{ + "type":"string", + "max":200, + "min":1 + }, + "FolderSearchFilter":{ + "type":"structure", + "members":{ + "Operator":{"shape":"FilterOperator"}, + "Name":{"shape":"FolderFilterAttribute"}, + "Value":{"shape":"String"} + } + }, + "FolderSearchFilterList":{ + "type":"list", + "member":{"shape":"FolderSearchFilter"}, + "max":100 + }, + "FolderSummary":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "FolderId":{"shape":"RestrictiveResourceId"}, + "Name":{"shape":"FolderName"}, + "FolderType":{"shape":"FolderType"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"} + } + }, + "FolderSummaryList":{ + "type":"list", + "member":{"shape":"FolderSummary"}, + "max":100 + }, + "FolderType":{ + "type":"string", + "enum":["SHARED"] + }, "GeoSpatialColumnGroup":{ "type":"structure", "required":[ @@ -5215,6 +5736,82 @@ } } }, + "ListFolderMembersRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "box":true, + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListFolderMembersResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "FolderMemberList":{"shape":"FolderMemberList"}, + "NextToken":{"shape":"String"}, + "RequestId":{"shape":"String"} + } + }, + "ListFoldersRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "box":true, + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListFoldersResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "FolderSummaryList":{"shape":"FolderSummaryList"}, + "NextToken":{"shape":"String"}, + "RequestId":{"shape":"String"} + } + }, "ListGroupMembershipsRequest":{ "type":"structure", "required":[ @@ -5905,6 +6502,21 @@ "max":100, "min":1 }, + "MemberIdArnPair":{ + "type":"structure", + "members":{ + "MemberId":{"shape":"RestrictiveResourceId"}, + "MemberArn":{"shape":"Arn"} + } + }, + "MemberType":{ + "type":"string", + "enum":[ + "DASHBOARD", + "ANALYSIS", + "DATASET" + ] + }, "MySqlParameters":{ "type":"structure", "required":[ @@ -6015,6 +6627,12 @@ "max":1024, "min":1 }, + "Path":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, "PhysicalTable":{ "type":"structure", "members":{ @@ -6485,6 +7103,38 @@ "RequestId":{"shape":"String"} } }, + "SearchFoldersRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "Filters" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Filters":{"shape":"FolderSearchFilterList"}, + "NextToken":{"shape":"String"}, + "MaxResults":{ + "shape":"MaxResults", + "box":true + } + } + }, + "SearchFoldersResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "FolderSummaryList":{"shape":"FolderSummaryList"}, + "NextToken":{"shape":"String"}, + "RequestId":{"shape":"String"} + } + }, "ServiceNowParameters":{ "type":"structure", "required":["SiteBaseUrl"], @@ -7437,6 +8087,70 @@ } } }, + "UpdateFolderPermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "GrantPermissions":{"shape":"ResourcePermissionList"}, + "RevokePermissions":{"shape":"ResourcePermissionList"} + } + }, + "UpdateFolderPermissionsResponse":{ + "type":"structure", + "members":{ + "Status":{"shape":"StatusCode"}, + "Arn":{"shape":"Arn"}, + "FolderId":{"shape":"RestrictiveResourceId"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "RequestId":{"shape":"String"} + } + }, + "UpdateFolderRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "FolderId", + "Name" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "FolderId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"FolderId" + }, + "Name":{"shape":"FolderName"} + } + }, + "UpdateFolderResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Arn":{"shape":"Arn"}, + "FolderId":{"shape":"RestrictiveResourceId"}, + "RequestId":{"shape":"String"} + } + }, "UpdateGroupRequest":{ "type":"structure", "required":[ diff --git a/models/apis/quicksight/2018-04-01/docs-2.json b/models/apis/quicksight/2018-04-01/docs-2.json index c53a4b0d1cc..f0b503bf18f 100644 --- a/models/apis/quicksight/2018-04-01/docs-2.json +++ b/models/apis/quicksight/2018-04-01/docs-2.json @@ -8,6 +8,8 @@ "CreateDashboard": "Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
", "CreateDataSet": "Creates a dataset.
", "CreateDataSource": "Creates a data source.
", + "CreateFolder": "Creates an empty shared folder.
", + "CreateFolderMembership": "Adds an asset, such as a dashboard, analysis, or dataset into a folder.
", "CreateGroup": "Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
", "CreateGroupMembership": "Adds an Amazon QuickSight user to an Amazon QuickSight group.
", "CreateIAMPolicyAssignment": "Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
", @@ -22,6 +24,8 @@ "DeleteDashboard": "Deletes a dashboard.
", "DeleteDataSet": "Deletes a dataset.
", "DeleteDataSource": "Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
", + "DeleteFolder": "Deletes an empty folder.
", + "DeleteFolderMembership": "Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
", "DeleteGroup": "Removes a user group from Amazon QuickSight.
", "DeleteGroupMembership": "Removes a user from a group so that the user is no longer a member of the group.
", "DeleteIAMPolicyAssignment": "Deletes an existing IAM policy assignment.
", @@ -42,6 +46,9 @@ "DescribeDataSetPermissions": "Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Describes a data source.
", "DescribeDataSourcePermissions": "Describes the resource permissions for a data source.
", + "DescribeFolder": "Describes a folder.
", + "DescribeFolderPermissions": "Describes permissions for a folder.
", + "DescribeFolderResolvedPermissions": "Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
", "DescribeGroup": "Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
", "DescribeIAMPolicyAssignment": "Describes an existing IAM policy assignment, as specified by the assignment name.
", "DescribeIngestion": "Describes a SPICE ingestion.
", @@ -60,6 +67,8 @@ "ListDashboards": "Lists dashboards in an AWS account.
", "ListDataSets": "Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists data sources in current AWS Region that belong to this AWS account.
", + "ListFolderMembers": "List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
Lists all folders in an account.
", "ListGroupMemberships": "Lists member users in a group.
", "ListGroups": "Lists all user groups in Amazon QuickSight.
", "ListIAMPolicyAssignments": "Lists IAM policy assignments in the current Amazon QuickSight account.
", @@ -79,6 +88,7 @@ "RestoreAnalysis": "Restores an analysis.
", "SearchAnalyses": "Searches for analyses that belong to the user specified in the filter.
", "SearchDashboards": "Searches for dashboards that belong to a user.
", + "SearchFolders": "Searches the subfolders in a folder.
", "TagResource": "Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
Removes a tag or tags from a resource.
", "UpdateAccountCustomization": "Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Updates a data source.
", "UpdateDataSourcePermissions": "Updates the permissions to a data source.
", + "UpdateFolder": "Updates the name of a folder.
", + "UpdateFolderPermissions": "Updates permissions of a folder.
", "UpdateGroup": "Changes a group description.
", "UpdateIAMPolicyAssignment": "Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
Updates a template from an existing Amazon QuickSight analysis or another template.
", @@ -276,6 +288,8 @@ "CreateDataSetResponse$Arn": "The Amazon Resource Name (ARN) of the dataset.
", "CreateDataSetResponse$IngestionArn": "The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
", "CreateDataSourceResponse$Arn": "The Amazon Resource Name (ARN) of the data source.
", + "CreateFolderRequest$ParentFolderArn": "The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
The Amazon Resource Name (ARN) for the newly created folder.
", "CreateIAMPolicyAssignmentRequest$PolicyArn": "The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
", "CreateIAMPolicyAssignmentResponse$PolicyArn": "The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
", "CreateIngestionResponse$Arn": "The Amazon Resource Name (ARN) for the data ingestion.
", @@ -302,6 +316,7 @@ "DeleteDashboardResponse$Arn": "The Secure Socket Layer (SSL) properties that apply for the resource.
", "DeleteDataSetResponse$Arn": "The Amazon Resource Name (ARN) of the dataset.
", "DeleteDataSourceResponse$Arn": "The Amazon Resource Name (ARN) of the data source that you deleted.
", + "DeleteFolderResponse$Arn": "The Amazon Resource Name of the deleted folder.
", "DeleteTemplateAliasResponse$Arn": "The Amazon Resource Name (ARN) of the template you want to delete.
", "DeleteTemplateResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
", "DeleteThemeAliasResponse$Arn": "The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
", @@ -311,8 +326,12 @@ "DescribeDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
", "DescribeDataSetPermissionsResponse$DataSetArn": "The Amazon Resource Name (ARN) of the dataset.
", "DescribeDataSourcePermissionsResponse$DataSourceArn": "The Amazon Resource Name (ARN) of the data source.
", + "DescribeFolderPermissionsResponse$Arn": "The Amazon Resource Name (ARN) for the folder.
", + "DescribeFolderResolvedPermissionsResponse$Arn": "The Amazon Resource Name (ARN).
", "DescribeTemplatePermissionsResponse$TemplateArn": "The Amazon Resource Name (ARN) of the template.
", "DescribeThemePermissionsResponse$ThemeArn": "The Amazon Resource Name (ARN) of the theme.
", + "Folder$Arn": "The folder Amazon Resource Name (ARN).
", + "FolderSummary$Arn": "The Amazon Resource Name (ARN).
", "GetDashboardEmbedUrlRequest$UserArn": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
", "GetSessionEmbedUrlRequest$UserArn": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
", "Group$Arn": "The Amazon Resource Name (ARN) for the group.
", @@ -320,7 +339,9 @@ "IAMPolicyAssignment$PolicyArn": "The Amazon Resource Name (ARN) for the IAM policy.
", "Ingestion$Arn": "The Amazon Resource Name (ARN) of the resource.
", "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
", + "MemberIdArnPair$MemberArn": "The Amazon Resource Name (ARN) of the member.
", "NamespaceInfoV2$Arn": "The namespace ARN.
", + "Path$member": null, "RelationalTable$DataSourceArn": "The Amazon Resource Name (ARN) for the data source.
", "RestoreAnalysisResponse$Arn": "The Amazon Resource Name (ARN) of the analysis that you're restoring.
", "RowLevelPermissionDataSet$Arn": "The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
", @@ -354,6 +375,8 @@ "UpdateDataSetResponse$IngestionArn": "The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
", "UpdateDataSourcePermissionsResponse$DataSourceArn": "The Amazon Resource Name (ARN) of the data source.
", "UpdateDataSourceResponse$Arn": "The Amazon Resource Name (ARN) of the data source.
", + "UpdateFolderPermissionsResponse$Arn": "The Amazon Resource Name (ARN).
", + "UpdateFolderResponse$Arn": "The Amazon Resource Name (ARN).
", "UpdateIAMPolicyAssignmentRequest$PolicyArn": "The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
", "UpdateIAMPolicyAssignmentResponse$PolicyArn": "The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
", "UpdateTemplatePermissionsResponse$TemplateArn": "The Amazon Resource Name (ARN) of the template.
", @@ -406,6 +429,8 @@ "CreateDashboardRequest$AwsAccountId": "The ID of the AWS account where you want to create the dashboard.
", "CreateDataSetRequest$AwsAccountId": "The AWS account ID.
", "CreateDataSourceRequest$AwsAccountId": "The AWS account ID.
", + "CreateFolderMembershipRequest$AwsAccountId": "The AWS Account ID.
", + "CreateFolderRequest$AwsAccountId": "The AWS Account ID.
", "CreateGroupMembershipRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "CreateGroupRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "CreateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
", @@ -420,6 +445,8 @@ "DeleteDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're deleting.
", "DeleteDataSetRequest$AwsAccountId": "The AWS account ID.
", "DeleteDataSourceRequest$AwsAccountId": "The AWS account ID.
", + "DeleteFolderMembershipRequest$AwsAccountId": "The AWS Account ID.
", + "DeleteFolderRequest$AwsAccountId": "The AWS Account ID for the folder.
", "DeleteGroupMembershipRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "DeleteGroupRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "DeleteIAMPolicyAssignmentRequest$AwsAccountId": "The AWS account ID where you want to delete the IAM policy assignment.
", @@ -441,6 +468,9 @@ "DescribeDataSetRequest$AwsAccountId": "The AWS account ID.
", "DescribeDataSourcePermissionsRequest$AwsAccountId": "The AWS account ID.
", "DescribeDataSourceRequest$AwsAccountId": "The AWS account ID.
", + "DescribeFolderPermissionsRequest$AwsAccountId": "The AWS Account ID.
", + "DescribeFolderRequest$AwsAccountId": "The AWS account ID.
", + "DescribeFolderResolvedPermissionsRequest$AwsAccountId": "The AWS account ID.
", "DescribeGroupRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "DescribeIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account that contains the assignment that you want to describe.
", "DescribeIngestionRequest$AwsAccountId": "The AWS account ID.
", @@ -459,6 +489,8 @@ "ListDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboards that you're listing.
", "ListDataSetsRequest$AwsAccountId": "The AWS account ID.
", "ListDataSourcesRequest$AwsAccountId": "The AWS account ID.
", + "ListFolderMembersRequest$AwsAccountId": "The AWS account ID.
", + "ListFoldersRequest$AwsAccountId": "The AWS account ID.
", "ListGroupMembershipsRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "ListGroupsRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "ListIAMPolicyAssignmentsForUserRequest$AwsAccountId": "The ID of the AWS account that contains the assignments.
", @@ -477,6 +509,7 @@ "RestoreAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis.
", "SearchAnalysesRequest$AwsAccountId": "The ID of the AWS account that contains the analyses that you're searching for.
", "SearchDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the user whose dashboards you're searching for.
", + "SearchFoldersRequest$AwsAccountId": "The AWS account ID.
", "UpdateAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
", "UpdateAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
", "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight settings that you want to list.
", @@ -489,6 +522,8 @@ "UpdateDataSetRequest$AwsAccountId": "The AWS account ID.
", "UpdateDataSourcePermissionsRequest$AwsAccountId": "The AWS account ID.
", "UpdateDataSourceRequest$AwsAccountId": "The AWS account ID.
", + "UpdateFolderPermissionsRequest$AwsAccountId": "The AWS account ID.
", + "UpdateFolderRequest$AwsAccountId": "The AWS account ID.
", "UpdateGroupRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "UpdateIAMPolicyAssignmentRequest$AwsAccountId": "The ID of the AWS account that contains the IAM policy assignment.
", "UpdateTemplateAliasRequest$AwsAccountId": "The ID of the AWS account that contains the template alias that you're updating.
", @@ -784,6 +819,26 @@ "refs": { } }, + "CreateFolderMembershipRequest": { + "base": null, + "refs": { + } + }, + "CreateFolderMembershipResponse": { + "base": null, + "refs": { + } + }, + "CreateFolderRequest": { + "base": null, + "refs": { + } + }, + "CreateFolderResponse": { + "base": null, + "refs": { + } + }, "CreateGroupMembershipRequest": { "base": null, "refs": { @@ -1230,6 +1285,26 @@ "refs": { } }, + "DeleteFolderMembershipRequest": { + "base": null, + "refs": { + } + }, + "DeleteFolderMembershipResponse": { + "base": null, + "refs": { + } + }, + "DeleteFolderRequest": { + "base": null, + "refs": { + } + }, + "DeleteFolderResponse": { + "base": null, + "refs": { + } + }, "DeleteGroupMembershipRequest": { "base": null, "refs": { @@ -1436,6 +1511,36 @@ "refs": { } }, + "DescribeFolderPermissionsRequest": { + "base": null, + "refs": { + } + }, + "DescribeFolderPermissionsResponse": { + "base": null, + "refs": { + } + }, + "DescribeFolderRequest": { + "base": null, + "refs": { + } + }, + "DescribeFolderResolvedPermissionsRequest": { + "base": null, + "refs": { + } + }, + "DescribeFolderResolvedPermissionsResponse": { + "base": null, + "refs": { + } + }, + "DescribeFolderResponse": { + "base": null, + "refs": { + } + }, "DescribeGroupRequest": { "base": null, "refs": { @@ -1664,7 +1769,14 @@ "base": null, "refs": { "AnalysisSearchFilter$Operator": "The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\".
The comparison operator that you want to use as a filter, for example, \"Operator\": \"StringEquals\".
The comparison operator that you want to use as a filter, for example, \"Operator\": \"StringEquals\".
The comparison operator that you want to use as a filter. For example, \"Operator\": \"StringEquals\".
A folder.
", + "refs": { + "DescribeFolderResponse$Folder": "Information about the folder.
" } }, "FolderColumnList": { @@ -1673,6 +1785,66 @@ "FieldFolder$columns": "A folder has a list of columns. A column can only be in one folder.
" } }, + "FolderFilterAttribute": { + "base": null, + "refs": { + "FolderSearchFilter$Name": "The name of the value that you want to use as a filter. For example, \"Name\": \"PARENT_FOLDER_ARN\".
An asset in a folder, such as a dashboard, analysis, or dataset.
", + "refs": { + "CreateFolderMembershipResponse$FolderMember": "Information about the member in the folder.
" + } + }, + "FolderMemberList": { + "base": null, + "refs": { + "ListFolderMembersResponse$FolderMemberList": "A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
" + } + }, + "FolderName": { + "base": null, + "refs": { + "CreateFolderRequest$Name": "The name of the folder.
", + "Folder$Name": "A display name for the folder.
", + "FolderSummary$Name": "The display name of the folder.
", + "UpdateFolderRequest$Name": "The name of the folder.
" + } + }, + "FolderSearchFilter": { + "base": "Searches a folder by a filter.
", + "refs": { + "FolderSearchFilterList$member": null + } + }, + "FolderSearchFilterList": { + "base": null, + "refs": { + "SearchFoldersRequest$Filters": "The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].
A summary of the folder.
", + "refs": { + "FolderSummaryList$member": null + } + }, + "FolderSummaryList": { + "base": null, + "refs": { + "ListFoldersResponse$FolderSummaryList": "A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
", + "SearchFoldersResponse$FolderSummaryList": "A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
" + } + }, + "FolderType": { + "base": null, + "refs": { + "CreateFolderRequest$FolderType": "The type of folder. By default, folderType is SHARED.
The type of the folder.
", + "FolderSummary$FolderType": "The type of folder.
" + } + }, "GeoSpatialColumnGroup": { "base": "Geospatial column group that denotes a hierarchy.
", "refs": { @@ -1962,7 +2134,7 @@ "refs": { "CustomSql$Columns": "The column schema from the SQL query result set.
", "RelationalTable$InputColumns": "The column schema of the table.
", - "S3Source$InputColumns": "A physical table type for as S3 data source.
" + "S3Source$InputColumns": "A physical table type for an S3 data source.
For non-JSON files, only STRING data types are supported in input columns.
The maximum number of results to be returned per request.
", "ListDataSetsRequest$MaxResults": "The maximum number of results to be returned per request.
", "ListDataSourcesRequest$MaxResults": "The maximum number of results to be returned per request.
", + "ListFolderMembersRequest$MaxResults": "The maximum number of results to be returned per request.
", + "ListFoldersRequest$MaxResults": "The maximum number of results to be returned per request.
", "ListGroupMembershipsRequest$MaxResults": "The maximum number of results to return from this request.
", "ListGroupsRequest$MaxResults": "The maximum number of results to return.
", "ListIAMPolicyAssignmentsForUserRequest$MaxResults": "The maximum number of results to be returned per request.
", @@ -2315,7 +2509,22 @@ "ListUserGroupsRequest$MaxResults": "The maximum number of results to return from this request.
", "ListUsersRequest$MaxResults": "The maximum number of results to return from this request.
", "SearchAnalysesRequest$MaxResults": "The maximum number of results to return.
", - "SearchDashboardsRequest$MaxResults": "The maximum number of results to be returned per request.
" + "SearchDashboardsRequest$MaxResults": "The maximum number of results to be returned per request.
", + "SearchFoldersRequest$MaxResults": "The maximum number of results to be returned per request.
" + } + }, + "MemberIdArnPair": { + "base": "An object that consists of the member Amazon Resource Name (ARN) and member ID.
", + "refs": { + "FolderMemberList$member": null + } + }, + "MemberType": { + "base": null, + "refs": { + "CreateFolderMembershipRequest$MemberType": "The type of the member, including DASHBOARD, ANALYSIS, and DATASET.
The type of the member, including DASHBOARD, ANALYSIS, and DATASET
The type of the asset.
" } }, "MySqlParameters": { @@ -2458,6 +2667,12 @@ "CredentialPair$Password": "Password.
" } }, + "Path": { + "base": null, + "refs": { + "Folder$FolderPath": "An array of ancestor folder ARN strings.
" + } + }, "PhysicalTable": { "base": "A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
", "refs": { @@ -2685,12 +2900,15 @@ "CreateDashboardRequest$Permissions": "A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
", "CreateDataSetRequest$Permissions": "A list of resource permissions on the dataset.
", "CreateDataSourceRequest$Permissions": "A list of resource permissions on the data source.
", + "CreateFolderRequest$Permissions": "A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions.
A list of resource permissions to be set on the template.
", "CreateThemeRequest$Permissions": "A valid grouping of resource permissions to apply to the new theme.
", "DescribeAnalysisPermissionsResponse$Permissions": "A structure that describes the principals and the resource-level permissions on an analysis.
", "DescribeDashboardPermissionsResponse$Permissions": "A structure that contains the permissions for the dashboard.
", "DescribeDataSetPermissionsResponse$Permissions": "A list of resource permissions on the dataset.
", "DescribeDataSourcePermissionsResponse$Permissions": "A list of resource permissions on the data source.
", + "DescribeFolderPermissionsResponse$Permissions": "Information about the permissions on the folder.
", + "DescribeFolderResolvedPermissionsResponse$Permissions": "Information about the permissions on the dashboard.
", "DescribeTemplatePermissionsResponse$Permissions": "A list of resource permissions to be set on the template.
", "DescribeThemePermissionsResponse$Permissions": "A list of resource permissions set on the theme.
", "UpdateAnalysisPermissionsResponse$Permissions": "A structure that describes the principals and the resource-level permissions on an analysis.
", @@ -2699,6 +2917,9 @@ "UpdateDataSetPermissionsRequest$RevokePermissions": "The resource permissions that you want to revoke from the dataset.
", "UpdateDataSourcePermissionsRequest$GrantPermissions": "A list of resource permissions that you want to grant on the data source.
", "UpdateDataSourcePermissionsRequest$RevokePermissions": "A list of resource permissions that you want to revoke on the data source.
", + "UpdateFolderPermissionsRequest$GrantPermissions": "The permissions that you want to grant on a resource.
", + "UpdateFolderPermissionsRequest$RevokePermissions": "The permissions that you want to revoke from a resource.
", + "UpdateFolderPermissionsResponse$Permissions": "Information about the permissions on the dashboard.
", "UpdateTemplatePermissionsResponse$Permissions": "A list of resource permissions to be set on the template.
", "UpdateThemePermissionsResponse$Permissions": "The resulting list of resource permissions for the theme.
" } @@ -2752,6 +2973,10 @@ "CreateAnalysisResponse$AnalysisId": "The ID of the analysis.
", "CreateDashboardRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
", "CreateDashboardResponse$DashboardId": "The ID for the dashboard.
", + "CreateFolderMembershipRequest$FolderId": "The folder ID.
", + "CreateFolderMembershipRequest$MemberId": "The ID of the asset (the dashboard, analysis, or dataset).
", + "CreateFolderRequest$FolderId": "The folder ID.
", + "CreateFolderResponse$FolderId": "The folder ID for the newly created folder.
", "CreateTemplateAliasRequest$TemplateId": "An ID for the template.
", "CreateTemplateRequest$TemplateId": "An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
", "CreateTemplateResponse$TemplateId": "The ID of the template.
", @@ -2765,6 +2990,10 @@ "DeleteAnalysisResponse$AnalysisId": "The ID of the deleted analysis.
", "DeleteDashboardRequest$DashboardId": "The ID for the dashboard.
", "DeleteDashboardResponse$DashboardId": "The ID of the dashboard.
", + "DeleteFolderMembershipRequest$FolderId": "The Folder ID.
", + "DeleteFolderMembershipRequest$MemberId": "The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
", + "DeleteFolderRequest$FolderId": "The folder ID.
", + "DeleteFolderResponse$FolderId": "The folder ID.
", "DeleteTemplateAliasRequest$TemplateId": "The ID for the template that the specified alias is for.
", "DeleteTemplateAliasResponse$TemplateId": "An ID for the template associated with the deletion.
", "DeleteTemplateRequest$TemplateId": "An ID for the template you want to delete.
", @@ -2779,6 +3008,11 @@ "DescribeDashboardPermissionsRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
", "DescribeDashboardPermissionsResponse$DashboardId": "The ID for the dashboard.
", "DescribeDashboardRequest$DashboardId": "The ID for the dashboard.
", + "DescribeFolderPermissionsRequest$FolderId": "The folder ID.
", + "DescribeFolderPermissionsResponse$FolderId": "The folder ID.
", + "DescribeFolderRequest$FolderId": "The folder ID.
", + "DescribeFolderResolvedPermissionsRequest$FolderId": "The folder ID.
", + "DescribeFolderResolvedPermissionsResponse$FolderId": "The folder ID.
", "DescribeTemplateAliasRequest$TemplateId": "The ID for the template.
", "DescribeTemplatePermissionsRequest$TemplateId": "The ID for the template.
", "DescribeTemplatePermissionsResponse$TemplateId": "The ID for the template.
", @@ -2787,12 +3021,17 @@ "DescribeThemePermissionsRequest$ThemeId": "The ID for the theme that you want to describe permissions for.
", "DescribeThemePermissionsResponse$ThemeId": "The ID for the theme.
", "DescribeThemeRequest$ThemeId": "The ID for the theme.
", + "Folder$FolderId": "The folder ID.
", + "FolderMember$MemberId": "The ID of the asset.
", + "FolderSummary$FolderId": "The folder ID.
", "GetDashboardEmbedUrlRequest$DashboardId": "The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.
", "ListDashboardVersionsRequest$DashboardId": "The ID for the dashboard.
", + "ListFolderMembersRequest$FolderId": "The folder ID.
", "ListTemplateAliasesRequest$TemplateId": "The ID for the template.
", "ListTemplateVersionsRequest$TemplateId": "The ID for the template.
", "ListThemeAliasesRequest$ThemeId": "The ID for the theme.
", "ListThemeVersionsRequest$ThemeId": "The ID for the theme.
", + "MemberIdArnPair$MemberId": "The ID of the member.
", "RestoreAnalysisRequest$AnalysisId": "The ID of the analysis that you're restoring.
", "RestoreAnalysisResponse$AnalysisId": "The ID of the analysis that you're restoring.
", "Sheet$SheetId": "The unique identifier associated with a sheet.
", @@ -2811,6 +3050,10 @@ "UpdateDashboardPublishedVersionResponse$DashboardId": "The ID for the dashboard.
", "UpdateDashboardRequest$DashboardId": "The ID for the dashboard.
", "UpdateDashboardResponse$DashboardId": "The ID for the dashboard.
", + "UpdateFolderPermissionsRequest$FolderId": "The folder ID.
", + "UpdateFolderPermissionsResponse$FolderId": "The folder ID.
", + "UpdateFolderRequest$FolderId": "The folder ID.
", + "UpdateFolderResponse$FolderId": "The folder ID.
", "UpdateTemplateAliasRequest$TemplateId": "The ID for the template.
", "UpdateTemplatePermissionsRequest$TemplateId": "The ID for the template.
", "UpdateTemplatePermissionsResponse$TemplateId": "The ID for the template.
", @@ -2884,7 +3127,7 @@ } }, "S3Source": { - "base": "A physical table type for as S3 data source.
", + "base": "A physical table type for an S3 data source.
", "refs": { "PhysicalTable$S3Source": "A physical table type for as S3 data source.
" } @@ -2909,6 +3152,16 @@ "refs": { } }, + "SearchFoldersRequest": { + "base": null, + "refs": { + } + }, + "SearchFoldersResponse": { + "base": null, + "refs": { + } + }, "ServiceNowParameters": { "base": "ServiceNow parameters.
", "refs": { @@ -3001,6 +3254,8 @@ "CreateDashboardResponse$Status": "The HTTP status of the request.
", "CreateDataSetResponse$Status": "The HTTP status of the request.
", "CreateDataSourceResponse$Status": "The HTTP status of the request.
", + "CreateFolderMembershipResponse$Status": "The status of the folder membership. If succeeded, the status is SC_OK (200).
The status of the newly created folder. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "CreateGroupResponse$Status": "The HTTP status of the request.
", "CreateIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", @@ -3015,6 +3270,8 @@ "DeleteDashboardResponse$Status": "The HTTP status of the request.
", "DeleteDataSetResponse$Status": "The HTTP status of the request.
", "DeleteDataSourceResponse$Status": "The HTTP status of the request.
", + "DeleteFolderMembershipResponse$Status": "The status of deleting the asset. If succeeded, the status is SC_OK (200).
The status of deleting the folder. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "DeleteGroupResponse$Status": "The HTTP status of the request.
", "DeleteIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", @@ -3035,6 +3292,9 @@ "DescribeDataSetResponse$Status": "The HTTP status of the request.
", "DescribeDataSourcePermissionsResponse$Status": "The HTTP status of the request.
", "DescribeDataSourceResponse$Status": "The HTTP status of the request.
", + "DescribeFolderPermissionsResponse$Status": "The status. If succeeded, the status is SC_OK.
The status. If succeeded, the status is SC_OK
The status. If succeeded, the status is SC_OK (200).
The HTTP status of the request.
", "DescribeIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", "DescribeIngestionResponse$Status": "The HTTP status of the request.
", @@ -3053,6 +3313,8 @@ "ListDashboardsResponse$Status": "The HTTP status of the request.
", "ListDataSetsResponse$Status": "The HTTP status of the request.
", "ListDataSourcesResponse$Status": "The HTTP status of the request.
", + "ListFolderMembersResponse$Status": "The status. If succeeded, the status is SC_OK
The status. If succeeded, the status is SC_OK
The HTTP status of the request.
", "ListGroupsResponse$Status": "The HTTP status of the request.
", "ListIAMPolicyAssignmentsForUserResponse$Status": "The HTTP status of the request.
", @@ -3072,6 +3334,7 @@ "RestoreAnalysisResponse$Status": "The HTTP status of the request.
", "SearchAnalysesResponse$Status": "The HTTP status of the request.
", "SearchDashboardsResponse$Status": "The HTTP status of the request.
", + "SearchFoldersResponse$Status": "The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "UntagResourceResponse$Status": "The HTTP status of the request.
", "UpdateAccountCustomizationResponse$Status": "The HTTP status of the request.
", @@ -3085,6 +3348,8 @@ "UpdateDataSetResponse$Status": "The HTTP status of the request.
", "UpdateDataSourcePermissionsResponse$Status": "The HTTP status of the request.
", "UpdateDataSourceResponse$Status": "The HTTP status of the request.
", + "UpdateFolderPermissionsResponse$Status": "The status. If succeeded, the status is SC_OK.
The status. If succeeded, the status is SC_OK.
The HTTP status of the request.
", "UpdateIAMPolicyAssignmentResponse$Status": "The HTTP status of the request.
", "UpdateTemplateAliasResponse$Status": "The HTTP status of the request.
", @@ -3120,6 +3385,8 @@ "CreateDashboardResponse$RequestId": "The AWS request ID for this operation.
", "CreateDataSetResponse$RequestId": "The AWS request ID for this operation.
", "CreateDataSourceResponse$RequestId": "The AWS request ID for this operation.
", + "CreateFolderMembershipResponse$RequestId": "The request ID.
", + "CreateFolderResponse$RequestId": "The request ID for the newly created folder.
", "CreateGroupMembershipResponse$RequestId": "The AWS request ID for this operation.
", "CreateGroupResponse$RequestId": "The AWS request ID for this operation.
", "CreateIAMPolicyAssignmentResponse$AssignmentId": "The ID for the assignment.
", @@ -3138,6 +3405,8 @@ "DeleteDashboardResponse$RequestId": "The AWS request ID for this operation.
", "DeleteDataSetResponse$RequestId": "The AWS request ID for this operation.
", "DeleteDataSourceResponse$RequestId": "The AWS request ID for this operation.
", + "DeleteFolderMembershipResponse$RequestId": "The request ID.
", + "DeleteFolderResponse$RequestId": "The request ID.
", "DeleteGroupMembershipResponse$RequestId": "The AWS request ID for this operation.
", "DeleteGroupResponse$RequestId": "The AWS request ID for this operation.
", "DeleteIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
", @@ -3159,6 +3428,9 @@ "DescribeDataSetResponse$RequestId": "The AWS request ID for this operation.
", "DescribeDataSourcePermissionsResponse$RequestId": "The AWS request ID for this operation.
", "DescribeDataSourceResponse$RequestId": "The AWS request ID for this operation.
", + "DescribeFolderPermissionsResponse$RequestId": "The request ID.
", + "DescribeFolderResolvedPermissionsResponse$RequestId": "The request ID.
", + "DescribeFolderResponse$RequestId": "The request ID.
", "DescribeGroupResponse$RequestId": "The AWS request ID for this operation.
", "DescribeIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
", "DescribeNamespaceResponse$RequestId": "The AWS request ID for this operation.
", @@ -3172,6 +3444,7 @@ "DomainNotWhitelistedException$Message": null, "DomainNotWhitelistedException$RequestId": "The AWS request ID for this request.
", "FolderColumnList$member": null, + "FolderSearchFilter$Value": "The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".
The AWS request ID for this operation.
", "GetSessionEmbedUrlResponse$RequestId": "The AWS request ID for this operation.
", "Group$PrincipalId": "The principal ID of the group.
", @@ -3202,6 +3475,12 @@ "ListDataSourcesRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListDataSourcesResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListDataSourcesResponse$RequestId": "The AWS request ID for this operation.
", + "ListFolderMembersRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListFolderMembersResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListFolderMembersResponse$RequestId": "The request ID.
", + "ListFoldersRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListFoldersResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", + "ListFoldersResponse$RequestId": "The request ID.
", "ListGroupMembershipsRequest$NextToken": "A pagination token that can be used in a subsequent request.
", "ListGroupMembershipsResponse$NextToken": "A pagination token that can be used in a subsequent request.
", "ListGroupMembershipsResponse$RequestId": "The AWS request ID for this operation.
", @@ -3270,6 +3549,9 @@ "SearchDashboardsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", "SearchDashboardsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", "SearchDashboardsResponse$RequestId": "The AWS request ID for this operation.
", + "SearchFoldersRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", + "SearchFoldersResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", + "SearchFoldersResponse$RequestId": "The request ID.
", "SessionLifetimeInMinutesInvalidException$Message": null, "SessionLifetimeInMinutesInvalidException$RequestId": "The AWS request ID for this request.
", "StringList$member": null, @@ -3293,6 +3575,8 @@ "UpdateDataSetResponse$RequestId": "The AWS request ID for this operation.
", "UpdateDataSourcePermissionsResponse$RequestId": "The AWS request ID for this operation.
", "UpdateDataSourceResponse$RequestId": "The AWS request ID for this operation.
", + "UpdateFolderPermissionsResponse$RequestId": "The request ID.
", + "UpdateFolderResponse$RequestId": "The request ID.
", "UpdateGroupResponse$RequestId": "The AWS request ID for this operation.
", "UpdateIAMPolicyAssignmentResponse$AssignmentId": "The ID of the assignment.
", "UpdateIAMPolicyAssignmentResponse$RequestId": "The AWS request ID for this operation.
", @@ -3365,6 +3649,7 @@ "CreateDashboardRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
", "CreateDataSetRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
", "CreateDataSourceRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
", + "CreateFolderRequest$Tags": "Tags for the folder.
", "CreateNamespaceRequest$Tags": "The tags that you want to associate with the namespace that you're creating.
", "CreateTemplateRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
", "CreateThemeRequest$Tags": "A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
", @@ -3629,6 +3914,10 @@ "DataSource$CreatedTime": "The time that this data source was created.
", "DataSource$LastUpdatedTime": "The last time that this data source was updated.
", "DeleteAnalysisResponse$DeletionTime": "The date and time that the analysis is scheduled to be deleted.
", + "Folder$CreatedTime": "The time that the folder was created.
", + "Folder$LastUpdatedTime": "The time that the folder was last updated.
", + "FolderSummary$CreatedTime": "The time that the folder was created.
", + "FolderSummary$LastUpdatedTime": "The time that the folder was last updated.
", "Template$LastUpdatedTime": "Time when this was last updated.
", "Template$CreatedTime": "Time when this was created.
", "TemplateSummary$CreatedTime": "The last time that this template was created.
", @@ -3810,6 +4099,26 @@ "refs": { } }, + "UpdateFolderPermissionsRequest": { + "base": null, + "refs": { + } + }, + "UpdateFolderPermissionsResponse": { + "base": null, + "refs": { + } + }, + "UpdateFolderRequest": { + "base": null, + "refs": { + } + }, + "UpdateFolderResponse": { + "base": null, + "refs": { + } + }, "UpdateGroupRequest": { "base": null, "refs": { diff --git a/service/cloud9/api.go b/service/cloud9/api.go index 2e717b9e1f7..128df1dfa23 100644 --- a/service/cloud9/api.go +++ b/service/cloud9/api.go @@ -57,9 +57,8 @@ func (c *Cloud9) CreateEnvironmentEC2Request(input *CreateEnvironmentEC2Input) ( // CreateEnvironmentEC2 API operation for AWS Cloud9. // -// Creates an AWS Cloud9 development environment, launches an Amazon Elastic -// Compute Cloud (Amazon EC2) instance, and then connects from the instance -// to the environment. +// Creates an Cloud9 development environment, launches an Amazon Elastic Compute +// Cloud (Amazon EC2) instance, and then connects from the instance to the environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -156,7 +155,7 @@ func (c *Cloud9) CreateEnvironmentMembershipRequest(input *CreateEnvironmentMemb // CreateEnvironmentMembership API operation for AWS Cloud9. // -// Adds an environment member to an AWS Cloud9 development environment. +// Adds an environment member to an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -254,8 +253,8 @@ func (c *Cloud9) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *r // DeleteEnvironment API operation for AWS Cloud9. // -// Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance -// is connected to the environment, also terminates the instance. +// Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected +// to the environment, also terminates the instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -353,7 +352,7 @@ func (c *Cloud9) DeleteEnvironmentMembershipRequest(input *DeleteEnvironmentMemb // DeleteEnvironmentMembership API operation for AWS Cloud9. // -// Deletes an environment member from an AWS Cloud9 development environment. +// Deletes an environment member from an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -456,8 +455,7 @@ func (c *Cloud9) DescribeEnvironmentMembershipsRequest(input *DescribeEnvironmen // DescribeEnvironmentMemberships API operation for AWS Cloud9. // -// Gets information about environment members for an AWS Cloud9 development -// environment. +// Gets information about environment members for an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -606,7 +604,7 @@ func (c *Cloud9) DescribeEnvironmentStatusRequest(input *DescribeEnvironmentStat // DescribeEnvironmentStatus API operation for AWS Cloud9. // -// Gets status information for an AWS Cloud9 development environment. +// Gets status information for an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -703,7 +701,7 @@ func (c *Cloud9) DescribeEnvironmentsRequest(input *DescribeEnvironmentsInput) ( // DescribeEnvironments API operation for AWS Cloud9. // -// Gets information about AWS Cloud9 development environments. +// Gets information about Cloud9 development environments. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -806,7 +804,7 @@ func (c *Cloud9) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *req // ListEnvironments API operation for AWS Cloud9. // -// Gets a list of AWS Cloud9 development environment identifiers. +// Gets a list of Cloud9 development environment identifiers. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -955,7 +953,7 @@ func (c *Cloud9) ListTagsForResourceRequest(input *ListTagsForResourceInput) (re // ListTagsForResource API operation for AWS Cloud9. // -// Gets a list of the tags associated with an AWS Cloud9 development environment. +// Gets a list of the tags associated with an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1041,10 +1039,10 @@ func (c *Cloud9) TagResourceRequest(input *TagResourceInput) (req *request.Reque // TagResource API operation for AWS Cloud9. // -// Adds tags to an AWS Cloud9 development environment. +// Adds tags to an Cloud9 development environment. // -// Tags that you add to an AWS Cloud9 environment by using this method will -// NOT be automatically propagated to underlying resources. +// Tags that you add to an Cloud9 environment by using this method will NOT +// be automatically propagated to underlying resources. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1133,7 +1131,7 @@ func (c *Cloud9) UntagResourceRequest(input *UntagResourceInput) (req *request.R // UntagResource API operation for AWS Cloud9. // -// Removes tags from an AWS Cloud9 development environment. +// Removes tags from an Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1222,7 +1220,7 @@ func (c *Cloud9) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req *r // UpdateEnvironment API operation for AWS Cloud9. // -// Changes the settings of an existing AWS Cloud9 development environment. +// Changes the settings of an existing Cloud9 development environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1319,8 +1317,8 @@ func (c *Cloud9) UpdateEnvironmentMembershipRequest(input *UpdateEnvironmentMemb // UpdateEnvironmentMembership API operation for AWS Cloud9. // -// Changes the settings of an existing environment member for an AWS Cloud9 -// development environment. +// Changes the settings of an existing environment member for an Cloud9 development +// environment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1548,20 +1546,20 @@ type CreateEnvironmentEC2Input struct { // has last been used. AutomaticStopTimeMinutes *int64 `locationName:"automaticStopTimeMinutes" type:"integer"` - // A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation + // A unique, case-sensitive string that helps Cloud9 to ensure this operation // completes no more than one time. // - // For more information, see Client Tokens (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) + // For more information, see Client Tokens (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) // in the Amazon EC2 API Reference. ClientRequestToken *string `locationName:"clientRequestToken" type:"string"` // The connection type used for connecting to an Amazon EC2 environment. Valid - // values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems - // Manager). + // values are CONNECT_SSH (default) and CONNECT_SSM (connected through Amazon + // EC2 Systems Manager). // - // For more information, see Accessing no-ingress EC2 instances with AWS Systems - // Manager (https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html) - // in the AWS Cloud9 User Guide. + // For more information, see Accessing no-ingress EC2 instances with Amazon + // EC2 Systems Manager (https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html) + // in the Cloud9 User Guide. ConnectionType *string `locationName:"connectionType" type:"string" enum:"ConnectionType"` // The description of the environment to create. @@ -1569,10 +1567,12 @@ type CreateEnvironmentEC2Input struct { // The identifier for the Amazon Machine Image (AMI) that's used to create the // EC2 instance. To choose an AMI for the instance, you must specify a valid - // AMI alias or a valid AWS Systems Manager (SSM) path. + // AMI alias or a valid Amazon EC2 Systems Manager (SSM) path. // // The default AMI is used if the parameter isn't explicitly assigned a value - // in the request. + // in the request. Because Amazon Linux AMI has ended standard support as of + // December 31, 2020, we recommend you choose Amazon Linux 2, which includes + // long term support through 2023. // // AMI aliases // @@ -1598,22 +1598,22 @@ type CreateEnvironmentEC2Input struct { // The name of the environment to create. // - // This name is visible to other AWS IAM users in the same AWS account. + // This name is visible to other IAM users in the same Amazon Web Services account. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of the environment owner. This ARN can be - // the ARN of any AWS IAM principal. If this value is not specified, the ARN - // defaults to this environment's creator. + // the ARN of any IAM principal. If this value is not specified, the ARN defaults + // to this environment's creator. OwnerArn *string `locationName:"ownerArn" type:"string"` - // The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate - // with the Amazon EC2 instance. + // The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with + // the Amazon EC2 instance. SubnetId *string `locationName:"subnetId" min:"15" type:"string"` - // An array of key-value pairs that will be associated with the new AWS Cloud9 - // development environment. + // An array of key-value pairs that will be associated with the new Cloud9 development + // environment. Tags []*Tag `locationName:"tags" type:"list" sensitive:"true"` } @@ -2223,7 +2223,7 @@ func (s *DescribeEnvironmentsOutput) SetEnvironments(v []*Environment) *Describe return s } -// Information about an AWS Cloud9 development environment. +// Information about an Cloud9 development environment. type Environment struct { _ struct{} `type:"structure"` @@ -2245,8 +2245,8 @@ type Environment struct { // The state of the environment in its creation or deletion lifecycle. Lifecycle *EnvironmentLifecycle `locationName:"lifecycle" type:"structure"` - // Describes the status of AWS managed temporary credentials for the AWS Cloud9 - // environment. Available values are: + // Describes the status of Amazon Web Services managed temporary credentials + // for the Cloud9 environment. Available values are: // // * ENABLED_ON_CREATE // @@ -2353,12 +2353,12 @@ func (s *Environment) SetType(v string) *Environment { } // Information about the current creation or deletion lifecycle state of an -// AWS Cloud9 development environment. +// Cloud9 development environment. type EnvironmentLifecycle struct { _ struct{} `type:"structure"` // If the environment failed to delete, the Amazon Resource Name (ARN) of the - // related AWS resource. + // related Amazon Web Services resource. FailureResource *string `locationName:"failureResource" type:"string"` // Any informational message about the lifecycle state of the environment. @@ -2406,7 +2406,7 @@ func (s *EnvironmentLifecycle) SetStatus(v string) *EnvironmentLifecycle { return s } -// Information about an environment member for an AWS Cloud9 development environment. +// Information about an environment member for an Cloud9 development environment. type EnvironmentMember struct { _ struct{} `type:"structure"` @@ -2436,8 +2436,7 @@ type EnvironmentMember struct { // UserArn is a required field UserArn *string `locationName:"userArn" type:"string" required:"true"` - // The user ID in AWS Identity and Access Management (AWS IAM) of the environment - // member. + // The user ID in Identity and Access Management (IAM) of the environment member. // // UserId is a required field UserId *string `locationName:"userId" type:"string" required:"true"` @@ -2726,8 +2725,8 @@ func (s *ListEnvironmentsOutput) SetNextToken(v string) *ListEnvironmentsOutput type ListTagsForResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the AWS Cloud9 development environment - // to get the tags for. + // The Amazon Resource Name (ARN) of the Cloud9 development environment to get + // the tags for. // // ResourceARN is a required field ResourceARN *string `type:"string" required:"true"` @@ -2765,7 +2764,7 @@ func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // The list of tags associated with the AWS Cloud9 development environment. + // The list of tags associated with the Cloud9 development environment. Tags []*Tag `type:"list" sensitive:"true"` } @@ -2841,11 +2840,12 @@ func (s *NotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Metadata that is associated with AWS resources. In particular, a name-value -// pair that can be associated with an AWS Cloud9 development environment. There -// are two types of tags: user tags and system tags. A user tag is created by -// the user. A system tag is automatically created by AWS services. A system -// tag is prefixed with "aws:" and cannot be modified by the user. +// Metadata that is associated with Amazon Web Services resources. In particular, +// a name-value pair that can be associated with an Cloud9 development environment. +// There are two types of tags: user tags and system tags. A user tag is created +// by the user. A system tag is automatically created by Amazon Web Services +// services. A system tag is prefixed with "aws:" and cannot be modified by +// the user. type Tag struct { _ struct{} `type:"structure" sensitive:"true"` @@ -2904,13 +2904,13 @@ func (s *Tag) SetValue(v string) *Tag { type TagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the AWS Cloud9 development environment - // to add tags to. + // The Amazon Resource Name (ARN) of the Cloud9 development environment to add + // tags to. // // ResourceARN is a required field ResourceARN *string `type:"string" required:"true"` - // The list of tags to add to the given AWS Cloud9 development environment. + // The list of tags to add to the given Cloud9 development environment. // // Tags is a required field Tags []*Tag `type:"list" required:"true" sensitive:"true"` @@ -3037,14 +3037,13 @@ func (s *TooManyRequestsException) RequestID() string { type UntagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the AWS Cloud9 development environment - // to remove tags from. + // The Amazon Resource Name (ARN) of the Cloud9 development environment to remove + // tags from. // // ResourceARN is a required field ResourceARN *string `type:"string" required:"true"` - // The tag names of the tags to remove from the given AWS Cloud9 development - // environment. + // The tag names of the tags to remove from the given Cloud9 development environment. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true" sensitive:"true"` diff --git a/service/cloud9/doc.go b/service/cloud9/doc.go index dd5fc61b903..b70038accf7 100644 --- a/service/cloud9/doc.go +++ b/service/cloud9/doc.go @@ -3,16 +3,15 @@ // Package cloud9 provides the client and types for making API // requests to AWS Cloud9. // -// AWS Cloud9 is a collection of tools that you can use to code, build, run, -// test, debug, and release software in the cloud. +// Cloud9 is a collection of tools that you can use to code, build, run, test, +// debug, and release software in the cloud. // -// For more information about AWS Cloud9, see the AWS Cloud9 User Guide (https://docs.aws.amazon.com/cloud9/latest/user-guide). +// For more information about Cloud9, see the Cloud9 User Guide (https://docs.aws.amazon.com/cloud9/latest/user-guide). // -// AWS Cloud9 supports these operations: +// Cloud9 supports these operations: // -// * CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, -// launches an Amazon EC2 instance, and then connects from the instance to -// the environment. +// * CreateEnvironmentEC2: Creates an Cloud9 development environment, launches +// an Amazon EC2 instance, and then connects from the instance to the environment. // // * CreateEnvironmentMembership: Adds an environment member to an environment. // diff --git a/service/cloud9/examples_test.go b/service/cloud9/examples_test.go index 498fd14a947..ed7ed7c769c 100644 --- a/service/cloud9/examples_test.go +++ b/service/cloud9/examples_test.go @@ -200,7 +200,7 @@ func ExampleCloud9_DeleteEnvironmentMembership_shared00() { // DescribeEnvironmentMemberships1 // // The following example gets information about all of the environment members for the -// specified AWS Cloud9 development environment. +// specified &AWS; Cloud9 development environment. func ExampleCloud9_DescribeEnvironmentMemberships_shared00() { svc := cloud9.New(session.New()) input := &cloud9.DescribeEnvironmentMembershipsInput{ @@ -241,7 +241,7 @@ func ExampleCloud9_DescribeEnvironmentMemberships_shared00() { // DescribeEnvironmentMemberships2 // -// The following example gets information about the owner of the specified AWS Cloud9 +// The following example gets information about the owner of the specified &AWS; Cloud9 // development environment. func ExampleCloud9_DescribeEnvironmentMemberships_shared01() { svc := cloud9.New(session.New()) @@ -286,7 +286,7 @@ func ExampleCloud9_DescribeEnvironmentMemberships_shared01() { // DescribeEnvironmentMemberships3 // -// The following example gets AWS Cloud9 development environment membership information +// The following example gets &AWS; Cloud9 development environment membership information // for the specified user. func ExampleCloud9_DescribeEnvironmentMemberships_shared02() { svc := cloud9.New(session.New()) diff --git a/service/cloudfront/api.go b/service/cloudfront/api.go index a88341c3863..022d6fef09b 100644 --- a/service/cloudfront/api.go +++ b/service/cloudfront/api.go @@ -25265,6 +25265,9 @@ const ( // MinimumProtocolVersionTlsv122019 is a MinimumProtocolVersion enum value MinimumProtocolVersionTlsv122019 = "TLSv1.2_2019" + + // MinimumProtocolVersionTlsv122021 is a MinimumProtocolVersion enum value + MinimumProtocolVersionTlsv122021 = "TLSv1.2_2021" ) // MinimumProtocolVersion_Values returns all elements of the MinimumProtocolVersion enum @@ -25276,6 +25279,7 @@ func MinimumProtocolVersion_Values() []string { MinimumProtocolVersionTlsv112016, MinimumProtocolVersionTlsv122018, MinimumProtocolVersionTlsv122019, + MinimumProtocolVersionTlsv122021, } } diff --git a/service/cloudsearch/api.go b/service/cloudsearch/api.go index dc3de223e2c..63b60b72bb7 100644 --- a/service/cloudsearch/api.go +++ b/service/cloudsearch/api.go @@ -160,6 +160,13 @@ func (c *CloudSearch) CreateDomainRequest(input *CreateDomainInput) (req *reques // * ErrCodeLimitExceededException "LimitExceeded" // The request was rejected because a resource limit has already been met. // +// * ErrCodeResourceAlreadyExistsException "ResourceAlreadyExists" +// The request was rejected because it attempted to create a resource that already +// exists. +// +// * ErrCodeValidationException "ValidationException" +// The request was rejected because it has invalid parameters. +// func (c *CloudSearch) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error) { req, out := c.CreateDomainRequest(input) return out, req.Send() @@ -6918,6 +6925,18 @@ const ( // PartitionInstanceTypeSearch2xlarge is a PartitionInstanceType enum value PartitionInstanceTypeSearch2xlarge = "search.2xlarge" + + // PartitionInstanceTypeSearchPreviousgenerationSmall is a PartitionInstanceType enum value + PartitionInstanceTypeSearchPreviousgenerationSmall = "search.previousgeneration.small" + + // PartitionInstanceTypeSearchPreviousgenerationLarge is a PartitionInstanceType enum value + PartitionInstanceTypeSearchPreviousgenerationLarge = "search.previousgeneration.large" + + // PartitionInstanceTypeSearchPreviousgenerationXlarge is a PartitionInstanceType enum value + PartitionInstanceTypeSearchPreviousgenerationXlarge = "search.previousgeneration.xlarge" + + // PartitionInstanceTypeSearchPreviousgeneration2xlarge is a PartitionInstanceType enum value + PartitionInstanceTypeSearchPreviousgeneration2xlarge = "search.previousgeneration.2xlarge" ) // PartitionInstanceType_Values returns all elements of the PartitionInstanceType enum @@ -6936,6 +6955,10 @@ func PartitionInstanceType_Values() []string { PartitionInstanceTypeSearchLarge, PartitionInstanceTypeSearchXlarge, PartitionInstanceTypeSearch2xlarge, + PartitionInstanceTypeSearchPreviousgenerationSmall, + PartitionInstanceTypeSearchPreviousgenerationLarge, + PartitionInstanceTypeSearchPreviousgenerationXlarge, + PartitionInstanceTypeSearchPreviousgeneration2xlarge, } } diff --git a/service/cloudsearch/errors.go b/service/cloudsearch/errors.go index b807f29ab04..76e1803734c 100644 --- a/service/cloudsearch/errors.go +++ b/service/cloudsearch/errors.go @@ -35,6 +35,13 @@ const ( // The request was rejected because a resource limit has already been met. ErrCodeLimitExceededException = "LimitExceeded" + // ErrCodeResourceAlreadyExistsException for service response error code + // "ResourceAlreadyExists". + // + // The request was rejected because it attempted to create a resource that already + // exists. + ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExists" + // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFound". // diff --git a/service/cloudwatchevents/api.go b/service/cloudwatchevents/api.go index 9a905f445a1..5db5d26dafb 100644 --- a/service/cloudwatchevents/api.go +++ b/service/cloudwatchevents/api.go @@ -1358,6 +1358,10 @@ func (c *CloudWatchEvents) DeleteRuleRequest(input *DeleteRuleInput) (req *reque // When you delete a rule, incoming events might continue to match to the deleted // rule. Allow a short period of time for changes to take effect. // +// If you call delete rule multiple times for the same rule, all calls will +// succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException +// is returned. +// // Managed rules are rules created and managed by another AWS service on your // behalf. These rules are created by those other AWS services to support functionality // in those services. You can delete these rules using the Force option, but @@ -3763,43 +3767,55 @@ func (c *CloudWatchEvents) PutTargetsRequest(input *PutTargetsInput) (req *reque // // You can configure the following as targets for Events: // -// * EC2 instances +// * API destination (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) // -// * SSM Run Command +// * Amazon API Gateway REST API endpoints // -// * SSM Automation +// * API Gateway +// +// * AWS Batch job queue +// +// * CloudWatch Logs group +// +// * CodeBuild project // -// * AWS Lambda functions +// * CodePineline // -// * Data streams in Amazon Kinesis Data Streams +// * Amazon EC2 CreateSnapshot API call // -// * Data delivery streams in Amazon Kinesis Data Firehose +// * Amazon EC2 RebootInstances API call +// +// * Amazon EC2 StopInstances API call +// +// * Amazon EC2 TerminateInstances API call // // * Amazon ECS tasks // -// * AWS Step Functions state machines +// * Event bus in a different AWS account or Region. You can use an event +// bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, +// or Europe (Ireland) eu-west-1 Regions as a target for a rule. // -// * AWS Batch jobs +// * Firehose delivery stream (Kinesis Data Firehose) // -// * AWS CodeBuild projects +// * Inspector assessment template (Amazon Inspector) // -// * Pipelines in AWS CodePipeline +// * Kinesis stream (Kinesis Data Stream) // -// * Amazon Inspector assessment templates +// * AWS Lambda function // -// * Amazon SNS topics +// * Redshift clusters (Data API statement execution) // -// * Amazon SQS queues, including FIFO queues +// * Amazon SNS topic // -// * The default event bus of another AWS account +// * Amazon SQS queues (includes FIFO queues // -// * Amazon API Gateway REST APIs +// * SSM Automation // -// * Redshift Clusters to invoke Data API ExecuteStatement on +// * SSM OpsItem // -// * Custom/SaaS HTTPS APIs via EventBridge API Destinations +// * SSM Run Command // -// * Amazon SageMaker Model Building Pipelines +// * Step Functions state machines // // Creating rules with built-in targets is supported only in the AWS Management // Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances @@ -4461,7 +4477,7 @@ func (c *CloudWatchEvents) UntagResourceRequest(input *UntagResourceInput) (req // UntagResource API operation for Amazon CloudWatch Events. // // Removes one or more tags from the specified EventBridge resource. In Amazon -// EventBridge (CloudWatch Events, rules and event buses can be tagged. +// EventBridge (CloudWatch Events), rules and event buses can be tagged. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5300,6 +5316,73 @@ func (s *CancelReplayOutput) SetStateReason(v string) *CancelReplayOutput { return s } +// The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem +// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// in the Amazon ECS API Reference. +type CapacityProviderStrategyItem struct { + _ struct{} `type:"structure"` + + // The base value designates how many tasks, at a minimum, to run on the specified + // capacity provider. Only one capacity provider in a capacity provider strategy + // can have a base defined. If no value is specified, the default value of 0 + // is used. + Base *int64 `locationName:"base" type:"integer"` + + // The short name of the capacity provider. + // + // CapacityProvider is a required field + CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true"` + + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight + // value is taken into consideration after the base value, if defined, is satisfied. + Weight *int64 `locationName:"weight" type:"integer"` +} + +// String returns the string representation +func (s CapacityProviderStrategyItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CapacityProviderStrategyItem) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacityProviderStrategyItem) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacityProviderStrategyItem"} + if s.CapacityProvider == nil { + invalidParams.Add(request.NewErrParamRequired("CapacityProvider")) + } + if s.CapacityProvider != nil && len(*s.CapacityProvider) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CapacityProvider", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBase sets the Base field's value. +func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem { + s.Base = &v + return s +} + +// SetCapacityProvider sets the CapacityProvider field's value. +func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem { + s.CapacityProvider = &v + return s +} + +// SetWeight sets the Weight field's value. +func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem { + s.Weight = &v + return s +} + // There is concurrent modification on a rule, target, archive, or replay. type ConcurrentModificationException struct { _ struct{} `type:"structure"` @@ -8576,6 +8659,23 @@ func (s DisableRuleOutput) GoString() string { type EcsParameters struct { _ struct{} `type:"structure"` + // The capacity provider strategy to use for the task. + // + // If a capacityProviderStrategy is specified, the launchType parameter must + // be omitted. If no capacityProviderStrategy or launchType is specified, the + // defaultCapacityProviderStrategy for the cluster is used. + CapacityProviderStrategy []*CapacityProviderStrategyItem `type:"list"` + + // Specifies whether to enable Amazon ECS managed tags for the task. For more + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // in the Amazon Elastic Container Service Developer Guide. + EnableECSManagedTags *bool `type:"boolean"` + + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. + EnableExecuteCommand *bool `type:"boolean"` + // Specifies an ECS task group for the task. The maximum length is 255 characters. Group *string `type:"string"` @@ -8596,6 +8696,15 @@ type EcsParameters struct { // the awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration `type:"structure"` + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition + // and those specified at runtime). + PlacementConstraints []*PlacementConstraint `type:"list"` + + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. + PlacementStrategy []*PlacementStrategy `type:"list"` + // Specifies the platform version for the task. Specify only the numeric portion // of the platform version, such as 1.1.0. // @@ -8604,6 +8713,21 @@ type EcsParameters struct { // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `type:"string"` + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be propagated + // to the task during task creation. To add tags to a task after task creation, + // use the TagResource API action. + PropagateTags *string `type:"string" enum:"PropagateTags"` + + // The reference ID to use for the task. + ReferenceId *string `type:"string"` + + // The metadata that you apply to the task to help you categorize and organize + // them. Each tag consists of a key and an optional value, both of which you + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // in the Amazon ECS API Reference. + Tags []*Tag `type:"list"` + // The number of tasks to create based on TaskDefinition. The default is 1. TaskCount *int64 `min:"1" type:"integer"` @@ -8636,11 +8760,31 @@ func (s *EcsParameters) Validate() error { if s.TaskDefinitionArn != nil && len(*s.TaskDefinitionArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("TaskDefinitionArn", 1)) } + if s.CapacityProviderStrategy != nil { + for i, v := range s.CapacityProviderStrategy { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CapacityProviderStrategy", i), err.(request.ErrInvalidParams)) + } + } + } if s.NetworkConfiguration != nil { if err := s.NetworkConfiguration.Validate(); err != nil { invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) } } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8648,6 +8792,24 @@ func (s *EcsParameters) Validate() error { return nil } +// SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value. +func (s *EcsParameters) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *EcsParameters { + s.CapacityProviderStrategy = v + return s +} + +// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. +func (s *EcsParameters) SetEnableECSManagedTags(v bool) *EcsParameters { + s.EnableECSManagedTags = &v + return s +} + +// SetEnableExecuteCommand sets the EnableExecuteCommand field's value. +func (s *EcsParameters) SetEnableExecuteCommand(v bool) *EcsParameters { + s.EnableExecuteCommand = &v + return s +} + // SetGroup sets the Group field's value. func (s *EcsParameters) SetGroup(v string) *EcsParameters { s.Group = &v @@ -8666,12 +8828,42 @@ func (s *EcsParameters) SetNetworkConfiguration(v *NetworkConfiguration) *EcsPar return s } +// SetPlacementConstraints sets the PlacementConstraints field's value. +func (s *EcsParameters) SetPlacementConstraints(v []*PlacementConstraint) *EcsParameters { + s.PlacementConstraints = v + return s +} + +// SetPlacementStrategy sets the PlacementStrategy field's value. +func (s *EcsParameters) SetPlacementStrategy(v []*PlacementStrategy) *EcsParameters { + s.PlacementStrategy = v + return s +} + // SetPlatformVersion sets the PlatformVersion field's value. func (s *EcsParameters) SetPlatformVersion(v string) *EcsParameters { s.PlatformVersion = &v return s } +// SetPropagateTags sets the PropagateTags field's value. +func (s *EcsParameters) SetPropagateTags(v string) *EcsParameters { + s.PropagateTags = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *EcsParameters) SetReferenceId(v string) *EcsParameters { + s.ReferenceId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *EcsParameters) SetTags(v []*Tag) *EcsParameters { + s.Tags = v + return s +} + // SetTaskCount sets the TaskCount field's value. func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters { s.TaskCount = &v @@ -8753,11 +8945,10 @@ func (s EnableRuleOutput) GoString() string { } // An event bus receives events from a source and routes them to rules associated -// with that event bus. Your account's default event bus receives rules from -// AWS services. A custom event bus can receive rules from AWS services as well -// as your custom applications and services. A partner event bus receives events -// from an event source created by an SaaS partner. These events come from the -// partners services or applications. +// with that event bus. Your account's default event bus receives events from +// AWS services. A custom event bus can receive events from your custom applications +// and services. A partner event bus receives events from an event source created +// by an SaaS partner. These events come from the partners services or applications. type EventBus struct { _ struct{} `type:"structure"` @@ -10829,6 +11020,92 @@ func (s *PartnerEventSourceAccount) SetState(v string) *PartnerEventSourceAccoun return s } +// An object representing a constraint on task placement. To learn more, see +// Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// in the Amazon Elastic Container Service Developer Guide. +type PlacementConstraint struct { + _ struct{} `type:"structure"` + + // A cluster query language expression to apply to the constraint. You cannot + // specify an expression if the constraint type is distinctInstance. To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // in the Amazon Elastic Container Service Developer Guide. + Expression *string `locationName:"expression" type:"string"` + + // The type of constraint. Use distinctInstance to ensure that each task in + // a particular group is running on a different container instance. Use memberOf + // to restrict the selection to a group of valid candidates. + Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"` +} + +// String returns the string representation +func (s PlacementConstraint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PlacementConstraint) GoString() string { + return s.String() +} + +// SetExpression sets the Expression field's value. +func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint { + s.Expression = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementConstraint) SetType(v string) *PlacementConstraint { + s.Type = &v + return s +} + +// The task placement strategy for a task or service. To learn more, see Task +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// in the Amazon Elastic Container Service Developer Guide. +type PlacementStrategy struct { + _ struct{} `type:"structure"` + + // The field to apply the placement strategy against. For the spread placement + // strategy, valid values are instanceId (or host, which has the same effect), + // or any platform or custom attribute that is applied to a container instance, + // such as attribute:ecs.availability-zone. For the binpack placement strategy, + // valid values are cpu and memory. For the random placement strategy, this + // field is not used. + Field *string `locationName:"field" type:"string"` + + // The type of placement strategy. The random placement strategy randomly places + // tasks on available candidates. The spread placement strategy spreads placement + // across available candidates evenly based on the field parameter. The binpack + // strategy places tasks on available candidates that have the least available + // amount of the resource that is specified with the field parameter. For example, + // if you binpack on memory, a task is placed on the instance with the least + // amount of remaining memory (but still enough to run the task). + Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"` +} + +// String returns the string representation +func (s PlacementStrategy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PlacementStrategy) GoString() string { + return s.String() +} + +// SetField sets the Field field's value. +func (s *PlacementStrategy) SetField(v string) *PlacementStrategy { + s.Field = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementStrategy) SetType(v string) *PlacementStrategy { + s.Type = &v + return s +} + // The event bus policy is too long. For more information, see the limits. type PolicyLengthExceededException struct { _ struct{} `type:"structure"` @@ -14399,6 +14676,54 @@ func LaunchType_Values() []string { } } +const ( + // PlacementConstraintTypeDistinctInstance is a PlacementConstraintType enum value + PlacementConstraintTypeDistinctInstance = "distinctInstance" + + // PlacementConstraintTypeMemberOf is a PlacementConstraintType enum value + PlacementConstraintTypeMemberOf = "memberOf" +) + +// PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum +func PlacementConstraintType_Values() []string { + return []string{ + PlacementConstraintTypeDistinctInstance, + PlacementConstraintTypeMemberOf, + } +} + +const ( + // PlacementStrategyTypeRandom is a PlacementStrategyType enum value + PlacementStrategyTypeRandom = "random" + + // PlacementStrategyTypeSpread is a PlacementStrategyType enum value + PlacementStrategyTypeSpread = "spread" + + // PlacementStrategyTypeBinpack is a PlacementStrategyType enum value + PlacementStrategyTypeBinpack = "binpack" +) + +// PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum +func PlacementStrategyType_Values() []string { + return []string{ + PlacementStrategyTypeRandom, + PlacementStrategyTypeSpread, + PlacementStrategyTypeBinpack, + } +} + +const ( + // PropagateTagsTaskDefinition is a PropagateTags enum value + PropagateTagsTaskDefinition = "TASK_DEFINITION" +) + +// PropagateTags_Values returns all elements of the PropagateTags enum +func PropagateTags_Values() []string { + return []string{ + PropagateTagsTaskDefinition, + } +} + const ( // ReplayStateStarting is a ReplayState enum value ReplayStateStarting = "STARTING" diff --git a/service/codegurureviewer/api.go b/service/codegurureviewer/api.go index d68c26109db..54c8e89db73 100644 --- a/service/codegurureviewer/api.go +++ b/service/codegurureviewer/api.go @@ -65,8 +65,8 @@ func (c *CodeGuruReviewer) AssociateRepositoryRequest(input *AssociateRepository // in Amazon CodeGuru Reviewer (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html) // in the Amazon CodeGuru Reviewer User Guide. // -// If you associate a CodeCommit repository, it must be in the same AWS Region -// and AWS account where its CodeGuru Reviewer code reviews are configured. +// If you associate a CodeCommit or S3 repository, it must be in the same AWS +// Region and AWS account where its CodeGuru Reviewer code reviews are configured. // // Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar // Connections to connect to CodeGuru Reviewer. For more information, see Associate @@ -173,8 +173,7 @@ func (c *CodeGuruReviewer) CreateCodeReviewRequest(input *CreateCodeReviewInput) // Use to create a code review with a CodeReviewType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) // of RepositoryAnalysis. This type of code review analyzes all code under a // specified branch in an associated repository. PullRequest code reviews are -// automatically triggered by a pull request so cannot be created using this -// method. +// automatically triggered by a pull request. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1732,6 +1731,132 @@ func (s *AssociateRepositoryOutput) SetTags(v map[string]*string) *AssociateRepo return s } +// A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) +// that specifies a code diff between a source and destination branch in an +// associated repository. +type BranchDiffSourceCodeType struct { + _ struct{} `type:"structure"` + + // The destination branch for a diff in an associated repository. + // + // DestinationBranchName is a required field + DestinationBranchName *string `min:"1" type:"string" required:"true"` + + // The source branch for a diff in an associated repository. + // + // SourceBranchName is a required field + SourceBranchName *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s BranchDiffSourceCodeType) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BranchDiffSourceCodeType) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BranchDiffSourceCodeType) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BranchDiffSourceCodeType"} + if s.DestinationBranchName == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationBranchName")) + } + if s.DestinationBranchName != nil && len(*s.DestinationBranchName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DestinationBranchName", 1)) + } + if s.SourceBranchName == nil { + invalidParams.Add(request.NewErrParamRequired("SourceBranchName")) + } + if s.SourceBranchName != nil && len(*s.SourceBranchName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceBranchName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinationBranchName sets the DestinationBranchName field's value. +func (s *BranchDiffSourceCodeType) SetDestinationBranchName(v string) *BranchDiffSourceCodeType { + s.DestinationBranchName = &v + return s +} + +// SetSourceBranchName sets the SourceBranchName field's value. +func (s *BranchDiffSourceCodeType) SetSourceBranchName(v string) *BranchDiffSourceCodeType { + s.SourceBranchName = &v + return s +} + +// Code artifacts are source code artifacts and build artifacts used in a repository +// analysis or a pull request review. +// +// * Source code artifacts are source code files in a Git repository that +// are compressed into a .zip file. +// +// * Build artifacts are .jar or .class files that are compressed in a .zip +// file. +type CodeArtifacts struct { + _ struct{} `type:"structure"` + + // The S3 object key for a build artifacts .zip file that contains .jar or .class + // files. This is required for a code review with security analysis. For more + // information, see Create code reviews with security analysis (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/code-review-security.html) + // in the Amazon CodeGuru Reviewer User Guide. + BuildArtifactsObjectKey *string `min:"1" type:"string"` + + // The S3 object key for a source code .zip file. This is required for all code + // reviews. + // + // SourceCodeArtifactsObjectKey is a required field + SourceCodeArtifactsObjectKey *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CodeArtifacts) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CodeArtifacts) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CodeArtifacts) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CodeArtifacts"} + if s.BuildArtifactsObjectKey != nil && len(*s.BuildArtifactsObjectKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BuildArtifactsObjectKey", 1)) + } + if s.SourceCodeArtifactsObjectKey == nil { + invalidParams.Add(request.NewErrParamRequired("SourceCodeArtifactsObjectKey")) + } + if s.SourceCodeArtifactsObjectKey != nil && len(*s.SourceCodeArtifactsObjectKey) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceCodeArtifactsObjectKey", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBuildArtifactsObjectKey sets the BuildArtifactsObjectKey field's value. +func (s *CodeArtifacts) SetBuildArtifactsObjectKey(v string) *CodeArtifacts { + s.BuildArtifactsObjectKey = &v + return s +} + +// SetSourceCodeArtifactsObjectKey sets the SourceCodeArtifactsObjectKey field's value. +func (s *CodeArtifacts) SetSourceCodeArtifactsObjectKey(v string) *CodeArtifacts { + s.SourceCodeArtifactsObjectKey = &v + return s +} + // Information about an AWS CodeCommit repository. The CodeCommit repository // must be in the same AWS Region and AWS account where its CodeGuru Reviewer // code reviews are configured. @@ -1783,6 +1908,10 @@ func (s *CodeCommitRepository) SetName(v string) *CodeCommitRepository { type CodeReview struct { _ struct{} `type:"structure"` + // They types of analysis performed during a repository analysis or a pull request + // review. You can specify either Security, CodeQuality, or both. + AnalysisTypes []*string `type:"list"` + // The Amazon Resource Name (ARN) of the RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) // that contains the reviewed source code. You can retrieve associated repository // ARNs by calling ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html). @@ -1808,7 +1937,8 @@ type CodeReview struct { // The owner of the repository. For an AWS CodeCommit repository, this is the // AWS account ID of the account that owns the repository. For a GitHub, GitHub // Enterprise Server, or Bitbucket repository, this is the username for the - // account that owns the repository. + // account that owns the repository. For an S3 repository, it can be the username + // or AWS account ID. Owner *string `min:"1" type:"string"` // The type of repository that contains the reviewed code (for example, GitHub @@ -1852,6 +1982,12 @@ func (s CodeReview) GoString() string { return s.String() } +// SetAnalysisTypes sets the AnalysisTypes field's value. +func (s *CodeReview) SetAnalysisTypes(v []*string) *CodeReview { + s.AnalysisTypes = v + return s +} + // SetAssociationArn sets the AssociationArn field's value. func (s *CodeReview) SetAssociationArn(v string) *CodeReview { s.AssociationArn = &v @@ -1960,7 +2096,8 @@ type CodeReviewSummary struct { // The owner of the repository. For an AWS CodeCommit repository, this is the // AWS account ID of the account that owns the repository. For a GitHub, GitHub // Enterprise Server, or Bitbucket repository, this is the username for the - // account that owns the repository. + // account that owns the repository. For an S3 repository, it can be the username + // or AWS account ID. Owner *string `min:"1" type:"string"` // The provider type of the repository association. @@ -1972,6 +2109,9 @@ type CodeReviewSummary struct { // The name of the repository. RepositoryName *string `min:"1" type:"string"` + // Specifies the source code that is analyzed in a code review. + SourceCodeType *SourceCodeType `type:"structure"` + // The state of the code review. // // The valid code review states are: @@ -2053,6 +2193,12 @@ func (s *CodeReviewSummary) SetRepositoryName(v string) *CodeReviewSummary { return s } +// SetSourceCodeType sets the SourceCodeType field's value. +func (s *CodeReviewSummary) SetSourceCodeType(v *SourceCodeType) *CodeReviewSummary { + s.SourceCodeType = v + return s +} + // SetState sets the State field's value. func (s *CodeReviewSummary) SetState(v string) *CodeReviewSummary { s.State = &v @@ -2068,9 +2214,7 @@ func (s *CodeReviewSummary) SetType(v string) *CodeReviewSummary { // The type of a code review. There are two code review types: // // * PullRequest - A code review that is automatically triggered by a pull -// request on an associated repository. Because this type of code review -// is automatically generated, you cannot specify this code review type using -// CreateCodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). +// request on an associated repository. // // * RepositoryAnalysis - A code review that analyzes all code under a specified // branch in an associated repository. The associated repository is specified @@ -2078,6 +2222,10 @@ func (s *CodeReviewSummary) SetType(v string) *CodeReviewSummary { type CodeReviewType struct { _ struct{} `type:"structure"` + // They types of analysis performed during a repository analysis or a pull request + // review. You can specify either Security, CodeQuality, or both. + AnalysisTypes []*string `type:"list"` + // A code review that analyzes all code under a specified branch in an associated // repository. The associated repository is specified using its ARN in CreateCodeReview // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). @@ -2114,6 +2262,12 @@ func (s *CodeReviewType) Validate() error { return nil } +// SetAnalysisTypes sets the AnalysisTypes field's value. +func (s *CodeReviewType) SetAnalysisTypes(v []*string) *CodeReviewType { + s.AnalysisTypes = v + return s +} + // SetRepositoryAnalysis sets the RepositoryAnalysis field's value. func (s *CodeReviewType) SetRepositoryAnalysis(v *RepositoryAnalysis) *CodeReviewType { s.RepositoryAnalysis = v @@ -2122,13 +2276,20 @@ func (s *CodeReviewType) SetRepositoryAnalysis(v *RepositoryAnalysis) *CodeRevie // A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the commit diff for a pull request on an associated repository. +// The SourceCommit and DestinationCommit fields are required to do a pull request +// code review. type CommitDiffSourceCodeType struct { _ struct{} `type:"structure"` - // The SHA of the destination commit used to generate a commit diff. + // The SHA of the destination commit used to generate a commit diff. This field + // is required for a pull request code review. DestinationCommit *string `min:"6" type:"string"` - // The SHA of the source commit used to generate a commit diff. + // The SHA of the merge base of a commit. + MergeBaseCommit *string `min:"6" type:"string"` + + // The SHA of the source commit used to generate a commit diff. This field is + // required for a pull request code review. SourceCommit *string `min:"6" type:"string"` } @@ -2142,12 +2303,37 @@ func (s CommitDiffSourceCodeType) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *CommitDiffSourceCodeType) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CommitDiffSourceCodeType"} + if s.DestinationCommit != nil && len(*s.DestinationCommit) < 6 { + invalidParams.Add(request.NewErrParamMinLen("DestinationCommit", 6)) + } + if s.MergeBaseCommit != nil && len(*s.MergeBaseCommit) < 6 { + invalidParams.Add(request.NewErrParamMinLen("MergeBaseCommit", 6)) + } + if s.SourceCommit != nil && len(*s.SourceCommit) < 6 { + invalidParams.Add(request.NewErrParamMinLen("SourceCommit", 6)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetDestinationCommit sets the DestinationCommit field's value. func (s *CommitDiffSourceCodeType) SetDestinationCommit(v string) *CommitDiffSourceCodeType { s.DestinationCommit = &v return s } +// SetMergeBaseCommit sets the MergeBaseCommit field's value. +func (s *CommitDiffSourceCodeType) SetMergeBaseCommit(v string) *CommitDiffSourceCodeType { + s.MergeBaseCommit = &v + return s +} + // SetSourceCommit sets the SourceCommit field's value. func (s *CommitDiffSourceCodeType) SetSourceCommit(v string) *CommitDiffSourceCodeType { s.SourceCommit = &v @@ -2663,6 +2849,57 @@ func (s *DisassociateRepositoryOutput) SetTags(v map[string]*string) *Disassocia return s } +// Information about an event. The event might be a push, pull request, scheduled +// request, or another type of event. +type EventInfo struct { + _ struct{} `type:"structure"` + + // The name of the event. The possible names are pull_request, workflow_dispatch, + // schedule, and push + Name *string `min:"1" type:"string"` + + // The state of an event. The state might be open, closed, or another state. + State *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s EventInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s EventInfo) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EventInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EventInfo"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.State != nil && len(*s.State) < 1 { + invalidParams.Add(request.NewErrParamMinLen("State", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *EventInfo) SetName(v string) *EventInfo { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *EventInfo) SetState(v string) *EventInfo { + s.State = &v + return s +} + // The server encountered an internal error and is unable to complete the request. type InternalServerException struct { _ struct{} `type:"structure"` @@ -3770,6 +4007,9 @@ type RecommendationSummary struct { // Name of the file on which a recommendation is provided. FilePath *string `min:"1" type:"string"` + // The type of a recommendation. + RecommendationCategory *string `type:"string" enum:"RecommendationCategory"` + // The recommendation ID that can be used to track the provided recommendations. // Later on it can be used to collect the feedback. RecommendationId *string `min:"1" type:"string"` @@ -3807,6 +4047,12 @@ func (s *RecommendationSummary) SetFilePath(v string) *RecommendationSummary { return s } +// SetRecommendationCategory sets the RecommendationCategory field's value. +func (s *RecommendationSummary) SetRecommendationCategory(v string) *RecommendationSummary { + s.RecommendationCategory = &v + return s +} + // SetRecommendationId sets the RecommendationId field's value. func (s *RecommendationSummary) SetRecommendationId(v string) *RecommendationSummary { s.RecommendationId = &v @@ -3834,6 +4080,9 @@ type Repository struct { // Information about a GitHub Enterprise Server repository. GitHubEnterpriseServer *ThirdPartySourceRepository `type:"structure"` + + // Information about a repository in an S3 bucket. + S3Bucket *S3Repository `type:"structure"` } // String returns the string representation @@ -3864,6 +4113,11 @@ func (s *Repository) Validate() error { invalidParams.AddNested("GitHubEnterpriseServer", err.(request.ErrInvalidParams)) } } + if s.S3Bucket != nil { + if err := s.S3Bucket.Validate(); err != nil { + invalidParams.AddNested("S3Bucket", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -3889,6 +4143,12 @@ func (s *Repository) SetGitHubEnterpriseServer(v *ThirdPartySourceRepository) *R return s } +// SetS3Bucket sets the S3Bucket field's value. +func (s *Repository) SetS3Bucket(v *S3Repository) *Repository { + s.S3Bucket = v + return s +} + // A code review type that analyzes all code under a specified branch in an // associated repository. The associated repository is specified using its ARN // when you call CreateCodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview). @@ -3897,9 +4157,10 @@ type RepositoryAnalysis struct { // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the tip of a branch in an associated repository. - // - // RepositoryHead is a required field - RepositoryHead *RepositoryHeadSourceCodeType `type:"structure" required:"true"` + RepositoryHead *RepositoryHeadSourceCodeType `type:"structure"` + + // Specifies the source code that is analyzed in a code review. + SourceCodeType *SourceCodeType `type:"structure"` } // String returns the string representation @@ -3915,14 +4176,16 @@ func (s RepositoryAnalysis) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *RepositoryAnalysis) Validate() error { invalidParams := request.ErrInvalidParams{Context: "RepositoryAnalysis"} - if s.RepositoryHead == nil { - invalidParams.Add(request.NewErrParamRequired("RepositoryHead")) - } if s.RepositoryHead != nil { if err := s.RepositoryHead.Validate(); err != nil { invalidParams.AddNested("RepositoryHead", err.(request.ErrInvalidParams)) } } + if s.SourceCodeType != nil { + if err := s.SourceCodeType.Validate(); err != nil { + invalidParams.AddNested("SourceCodeType", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -3936,6 +4199,12 @@ func (s *RepositoryAnalysis) SetRepositoryHead(v *RepositoryHeadSourceCodeType) return s } +// SetSourceCodeType sets the SourceCodeType field's value. +func (s *RepositoryAnalysis) SetSourceCodeType(v *SourceCodeType) *RepositoryAnalysis { + s.SourceCodeType = v + return s +} + // Information about a repository association. The DescribeRepositoryAssociation // (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html) // operation returns a RepositoryAssociation object. @@ -3977,12 +4246,18 @@ type RepositoryAssociation struct { // The owner of the repository. For an AWS CodeCommit repository, this is the // AWS account ID of the account that owns the repository. For a GitHub, GitHub // Enterprise Server, or Bitbucket repository, this is the username for the - // account that owns the repository. + // account that owns the repository. For an S3 repository, it can be the username + // or AWS account ID. Owner *string `min:"1" type:"string"` // The provider type of the repository association. ProviderType *string `type:"string" enum:"ProviderType"` + // Specifies the name of an S3 bucket and a CodeArtifacts object that contains + // the S3 object keys for a source code .zip file and for a build artifacts + // .zip file that contains .jar or .class files. + S3RepositoryDetails *S3RepositoryDetails `type:"structure"` + // The state of the repository association. // // The valid repository association states are: @@ -4080,6 +4355,12 @@ func (s *RepositoryAssociation) SetProviderType(v string) *RepositoryAssociation return s } +// SetS3RepositoryDetails sets the S3RepositoryDetails field's value. +func (s *RepositoryAssociation) SetS3RepositoryDetails(v *S3RepositoryDetails) *RepositoryAssociation { + s.S3RepositoryDetails = v + return s +} + // SetState sets the State field's value. func (s *RepositoryAssociation) SetState(v string) *RepositoryAssociation { s.State = &v @@ -4121,7 +4402,8 @@ type RepositoryAssociationSummary struct { // The owner of the repository. For an AWS CodeCommit repository, this is the // AWS account ID of the account that owns the repository. For a GitHub, GitHub // Enterprise Server, or Bitbucket repository, this is the username for the - // account that owns the repository. + // account that owns the repository. For an S3 repository, it can be the username + // or AWS account ID. Owner *string `min:"1" type:"string"` // The provider type of the repository association. @@ -4259,6 +4541,86 @@ func (s *RepositoryHeadSourceCodeType) SetBranchName(v string) *RepositoryHeadSo return s } +// Metadata that is associated with a code review. This applies to both pull +// request and repository analysis code reviews. +type RequestMetadata struct { + _ struct{} `type:"structure"` + + // Information about the event associated with a code review. + EventInfo *EventInfo `type:"structure"` + + // The ID of the request. This is required for a pull request code review. + RequestId *string `min:"1" type:"string"` + + // An identifier, such as a name or account ID, that is associated with the + // requester. The Requester is used to capture the author/actor name of the + // event request. + Requester *string `min:"1" type:"string"` + + // The name of the repository vendor used to upload code to an S3 bucket for + // a CI/CD code review. For example, if code and artifacts are uploaded to an + // S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, + // then the repository association's ProviderType is S3Bucket and the CI/CD + // repository vendor name is GitHub. For more information, see the definition + // for ProviderType in RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html). + VendorName *string `type:"string" enum:"VendorName"` +} + +// String returns the string representation +func (s RequestMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RequestMetadata) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RequestMetadata) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RequestMetadata"} + if s.RequestId != nil && len(*s.RequestId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RequestId", 1)) + } + if s.Requester != nil && len(*s.Requester) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Requester", 1)) + } + if s.EventInfo != nil { + if err := s.EventInfo.Validate(); err != nil { + invalidParams.AddNested("EventInfo", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEventInfo sets the EventInfo field's value. +func (s *RequestMetadata) SetEventInfo(v *EventInfo) *RequestMetadata { + s.EventInfo = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *RequestMetadata) SetRequestId(v string) *RequestMetadata { + s.RequestId = &v + return s +} + +// SetRequester sets the Requester field's value. +func (s *RequestMetadata) SetRequester(v string) *RequestMetadata { + s.Requester = &v + return s +} + +// SetVendorName sets the VendorName field's value. +func (s *RequestMetadata) SetVendorName(v string) *RequestMetadata { + s.VendorName = &v + return s +} + // The resource specified in the request was not found. type ResourceNotFoundException struct { _ struct{} `type:"structure"` @@ -4315,12 +4677,191 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Specifies the source code that is analyzed in a code review. A code review -// can analyze the source code that is specified using a pull request diff or -// a branch in an associated repository. +// Information about an associated repository in an S3 bucket. The associated +// repository contains a source code .zip file and a build artifacts .zip file +// that contains .jar or .class files. +type S3BucketRepository struct { + _ struct{} `type:"structure"` + + // An S3RepositoryDetails object that specifies the name of an S3 bucket and + // a CodeArtifacts object. The CodeArtifacts object includes the S3 object keys + // for a source code .zip file and for a build artifacts .zip file. + Details *S3RepositoryDetails `type:"structure"` + + // The name of the repository when the ProviderType is S3Bucket. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s S3BucketRepository) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s S3BucketRepository) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3BucketRepository) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3BucketRepository"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Details != nil { + if err := s.Details.Validate(); err != nil { + invalidParams.AddNested("Details", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDetails sets the Details field's value. +func (s *S3BucketRepository) SetDetails(v *S3RepositoryDetails) *S3BucketRepository { + s.Details = v + return s +} + +// SetName sets the Name field's value. +func (s *S3BucketRepository) SetName(v string) *S3BucketRepository { + s.Name = &v + return s +} + +// Information about a repository in an S3 bucket. +type S3Repository struct { + _ struct{} `type:"structure"` + + // The name of the S3 bucket used for associating a new S3 repository. It must + // begin with codeguru-reviewer-. + // + // BucketName is a required field + BucketName *string `min:"3" type:"string" required:"true"` + + // The name of the repository in the S3 bucket. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s S3Repository) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s S3Repository) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Repository) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Repository"} + if s.BucketName == nil { + invalidParams.Add(request.NewErrParamRequired("BucketName")) + } + if s.BucketName != nil && len(*s.BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("BucketName", 3)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketName sets the BucketName field's value. +func (s *S3Repository) SetBucketName(v string) *S3Repository { + s.BucketName = &v + return s +} + +// SetName sets the Name field's value. +func (s *S3Repository) SetName(v string) *S3Repository { + s.Name = &v + return s +} + +// Specifies the name of an S3 bucket and a CodeArtifacts object that contains +// the S3 object keys for a source code .zip file and for a build artifacts +// .zip file that contains .jar or .class files. +type S3RepositoryDetails struct { + _ struct{} `type:"structure"` + + // The name of the S3 bucket used for associating a new S3 repository. It must + // begin with codeguru-reviewer-. + BucketName *string `min:"3" type:"string"` + + // A CodeArtifacts object. The CodeArtifacts object includes the S3 object key + // for a source code .zip file and for a build artifacts .zip file that contains + // .jar or .class files. + CodeArtifacts *CodeArtifacts `type:"structure"` +} + +// String returns the string representation +func (s S3RepositoryDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s S3RepositoryDetails) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3RepositoryDetails) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3RepositoryDetails"} + if s.BucketName != nil && len(*s.BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("BucketName", 3)) + } + if s.CodeArtifacts != nil { + if err := s.CodeArtifacts.Validate(); err != nil { + invalidParams.AddNested("CodeArtifacts", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketName sets the BucketName field's value. +func (s *S3RepositoryDetails) SetBucketName(v string) *S3RepositoryDetails { + s.BucketName = &v + return s +} + +// SetCodeArtifacts sets the CodeArtifacts field's value. +func (s *S3RepositoryDetails) SetCodeArtifacts(v *CodeArtifacts) *S3RepositoryDetails { + s.CodeArtifacts = v + return s +} + +// Specifies the source code that is analyzed in a code review. type SourceCodeType struct { _ struct{} `type:"structure"` + // A type of SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // that specifies a source branch name and a destination branch name in an associated + // repository. + BranchDiff *BranchDiffSourceCodeType `type:"structure"` + // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies a commit diff created by a pull request on an associated repository. CommitDiff *CommitDiffSourceCodeType `type:"structure"` @@ -4328,6 +4869,20 @@ type SourceCodeType struct { // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) // that specifies the tip of a branch in an associated repository. RepositoryHead *RepositoryHeadSourceCodeType `type:"structure"` + + // Metadata that is associated with a code review. This applies to any type + // of code review supported by CodeGuru Reviewer. The RequestMetadaa field captures + // any event metadata. For example, it might capture metadata associated with + // an event trigger, such as a push or a pull request. + RequestMetadata *RequestMetadata `type:"structure"` + + // Information about an associated repository in an S3 bucket that includes + // its name and an S3RepositoryDetails object. The S3RepositoryDetails object + // includes the name of an S3 bucket, an S3 key for a source code .zip file, + // and an S3 key for a build artifacts .zip file. S3BucketRepository is required + // in SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) + // for S3BucketRepository based code reviews. + S3BucketRepository *S3BucketRepository `type:"structure"` } // String returns the string representation @@ -4340,6 +4895,47 @@ func (s SourceCodeType) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *SourceCodeType) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SourceCodeType"} + if s.BranchDiff != nil { + if err := s.BranchDiff.Validate(); err != nil { + invalidParams.AddNested("BranchDiff", err.(request.ErrInvalidParams)) + } + } + if s.CommitDiff != nil { + if err := s.CommitDiff.Validate(); err != nil { + invalidParams.AddNested("CommitDiff", err.(request.ErrInvalidParams)) + } + } + if s.RepositoryHead != nil { + if err := s.RepositoryHead.Validate(); err != nil { + invalidParams.AddNested("RepositoryHead", err.(request.ErrInvalidParams)) + } + } + if s.RequestMetadata != nil { + if err := s.RequestMetadata.Validate(); err != nil { + invalidParams.AddNested("RequestMetadata", err.(request.ErrInvalidParams)) + } + } + if s.S3BucketRepository != nil { + if err := s.S3BucketRepository.Validate(); err != nil { + invalidParams.AddNested("S3BucketRepository", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBranchDiff sets the BranchDiff field's value. +func (s *SourceCodeType) SetBranchDiff(v *BranchDiffSourceCodeType) *SourceCodeType { + s.BranchDiff = v + return s +} + // SetCommitDiff sets the CommitDiff field's value. func (s *SourceCodeType) SetCommitDiff(v *CommitDiffSourceCodeType) *SourceCodeType { s.CommitDiff = v @@ -4352,6 +4948,18 @@ func (s *SourceCodeType) SetRepositoryHead(v *RepositoryHeadSourceCodeType) *Sou return s } +// SetRequestMetadata sets the RequestMetadata field's value. +func (s *SourceCodeType) SetRequestMetadata(v *RequestMetadata) *SourceCodeType { + s.RequestMetadata = v + return s +} + +// SetS3BucketRepository sets the S3BucketRepository field's value. +func (s *SourceCodeType) SetS3BucketRepository(v *S3BucketRepository) *SourceCodeType { + s.S3BucketRepository = v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -4452,6 +5060,7 @@ type ThirdPartySourceRepository struct { // The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket // repository, this is the username for the account that owns the repository. + // For an S3 repository, this can be the username or AWS account ID. // // Owner is a required field Owner *string `min:"1" type:"string" required:"true"` @@ -4695,6 +5304,22 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } +const ( + // AnalysisTypeSecurity is a AnalysisType enum value + AnalysisTypeSecurity = "Security" + + // AnalysisTypeCodeQuality is a AnalysisType enum value + AnalysisTypeCodeQuality = "CodeQuality" +) + +// AnalysisType_Values returns all elements of the AnalysisType enum +func AnalysisType_Values() []string { + return []string{ + AnalysisTypeSecurity, + AnalysisTypeCodeQuality, + } +} + const ( // EncryptionOptionAwsOwnedCmk is a EncryptionOption enum value EncryptionOptionAwsOwnedCmk = "AWS_OWNED_CMK" @@ -4747,6 +5372,9 @@ const ( // ProviderTypeGitHubEnterpriseServer is a ProviderType enum value ProviderTypeGitHubEnterpriseServer = "GitHubEnterpriseServer" + + // ProviderTypeS3bucket is a ProviderType enum value + ProviderTypeS3bucket = "S3Bucket" ) // ProviderType_Values returns all elements of the ProviderType enum @@ -4756,6 +5384,7 @@ func ProviderType_Values() []string { ProviderTypeGitHub, ProviderTypeBitbucket, ProviderTypeGitHubEnterpriseServer, + ProviderTypeS3bucket, } } @@ -4775,6 +5404,54 @@ func Reaction_Values() []string { } } +const ( + // RecommendationCategoryAwsbestPractices is a RecommendationCategory enum value + RecommendationCategoryAwsbestPractices = "AWSBestPractices" + + // RecommendationCategoryAwscloudFormationIssues is a RecommendationCategory enum value + RecommendationCategoryAwscloudFormationIssues = "AWSCloudFormationIssues" + + // RecommendationCategoryDuplicateCode is a RecommendationCategory enum value + RecommendationCategoryDuplicateCode = "DuplicateCode" + + // RecommendationCategoryCodeMaintenanceIssues is a RecommendationCategory enum value + RecommendationCategoryCodeMaintenanceIssues = "CodeMaintenanceIssues" + + // RecommendationCategoryConcurrencyIssues is a RecommendationCategory enum value + RecommendationCategoryConcurrencyIssues = "ConcurrencyIssues" + + // RecommendationCategoryInputValidations is a RecommendationCategory enum value + RecommendationCategoryInputValidations = "InputValidations" + + // RecommendationCategoryPythonBestPractices is a RecommendationCategory enum value + RecommendationCategoryPythonBestPractices = "PythonBestPractices" + + // RecommendationCategoryJavaBestPractices is a RecommendationCategory enum value + RecommendationCategoryJavaBestPractices = "JavaBestPractices" + + // RecommendationCategoryResourceLeaks is a RecommendationCategory enum value + RecommendationCategoryResourceLeaks = "ResourceLeaks" + + // RecommendationCategorySecurityIssues is a RecommendationCategory enum value + RecommendationCategorySecurityIssues = "SecurityIssues" +) + +// RecommendationCategory_Values returns all elements of the RecommendationCategory enum +func RecommendationCategory_Values() []string { + return []string{ + RecommendationCategoryAwsbestPractices, + RecommendationCategoryAwscloudFormationIssues, + RecommendationCategoryDuplicateCode, + RecommendationCategoryCodeMaintenanceIssues, + RecommendationCategoryConcurrencyIssues, + RecommendationCategoryInputValidations, + RecommendationCategoryPythonBestPractices, + RecommendationCategoryJavaBestPractices, + RecommendationCategoryResourceLeaks, + RecommendationCategorySecurityIssues, + } +} + const ( // RepositoryAssociationStateAssociated is a RepositoryAssociationState enum value RepositoryAssociationStateAssociated = "Associated" @@ -4818,3 +5495,23 @@ func Type_Values() []string { TypeRepositoryAnalysis, } } + +const ( + // VendorNameGitHub is a VendorName enum value + VendorNameGitHub = "GitHub" + + // VendorNameGitLab is a VendorName enum value + VendorNameGitLab = "GitLab" + + // VendorNameNativeS3 is a VendorName enum value + VendorNameNativeS3 = "NativeS3" +) + +// VendorName_Values returns all elements of the VendorName enum +func VendorName_Values() []string { + return []string{ + VendorNameGitHub, + VendorNameGitLab, + VendorNameNativeS3, + } +} diff --git a/service/codegurureviewer/codegururevieweriface/interface.go b/service/codegurureviewer/codegururevieweriface/interface.go index e4292a279b9..b9aa824f748 100644 --- a/service/codegurureviewer/codegururevieweriface/interface.go +++ b/service/codegurureviewer/codegururevieweriface/interface.go @@ -127,6 +127,12 @@ type CodeGuruReviewerAPI interface { UntagResource(*codegurureviewer.UntagResourceInput) (*codegurureviewer.UntagResourceOutput, error) UntagResourceWithContext(aws.Context, *codegurureviewer.UntagResourceInput, ...request.Option) (*codegurureviewer.UntagResourceOutput, error) UntagResourceRequest(*codegurureviewer.UntagResourceInput) (*request.Request, *codegurureviewer.UntagResourceOutput) + + WaitUntilCodeReviewCompleted(*codegurureviewer.DescribeCodeReviewInput) error + WaitUntilCodeReviewCompletedWithContext(aws.Context, *codegurureviewer.DescribeCodeReviewInput, ...request.WaiterOption) error + + WaitUntilRepositoryAssociationSucceeded(*codegurureviewer.DescribeRepositoryAssociationInput) error + WaitUntilRepositoryAssociationSucceededWithContext(aws.Context, *codegurureviewer.DescribeRepositoryAssociationInput, ...request.WaiterOption) error } var _ CodeGuruReviewerAPI = (*codegurureviewer.CodeGuruReviewer)(nil) diff --git a/service/codegurureviewer/doc.go b/service/codegurureviewer/doc.go index a4642ff6993..0bb417830d3 100644 --- a/service/codegurureviewer/doc.go +++ b/service/codegurureviewer/doc.go @@ -6,7 +6,7 @@ // This section provides documentation for the Amazon CodeGuru Reviewer API // operations. CodeGuru Reviewer is a service that uses program analysis and // machine learning to detect potential defects that are difficult for developers -// to find and recommendations to address them in your Java and Python code. +// to find and recommends fixes in your Java and Python code. // // By proactively detecting and providing recommendations for addressing code // defects and implementing best practices, CodeGuru Reviewer improves the overall diff --git a/service/codegurureviewer/waiters.go b/service/codegurureviewer/waiters.go new file mode 100644 index 00000000000..be5669e771f --- /dev/null +++ b/service/codegurureviewer/waiters.go @@ -0,0 +1,112 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package codegurureviewer + +import ( + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" +) + +// WaitUntilCodeReviewCompleted uses the CodeGuruReviewer API operation +// DescribeCodeReview to wait for a condition to be met before returning. +// If the condition is not met within the max attempt window, an error will +// be returned. +func (c *CodeGuruReviewer) WaitUntilCodeReviewCompleted(input *DescribeCodeReviewInput) error { + return c.WaitUntilCodeReviewCompletedWithContext(aws.BackgroundContext(), input) +} + +// WaitUntilCodeReviewCompletedWithContext is an extended version of WaitUntilCodeReviewCompleted. +// With the support for passing in a context and options to configure the +// Waiter and the underlying request options. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CodeGuruReviewer) WaitUntilCodeReviewCompletedWithContext(ctx aws.Context, input *DescribeCodeReviewInput, opts ...request.WaiterOption) error { + w := request.Waiter{ + Name: "WaitUntilCodeReviewCompleted", + MaxAttempts: 60, + Delay: request.ConstantWaiterDelay(10 * time.Second), + Acceptors: []request.WaiterAcceptor{ + { + State: request.SuccessWaiterState, + Matcher: request.PathWaiterMatch, Argument: "CodeReview.State", + Expected: "Completed", + }, + { + State: request.RetryWaiterState, + Matcher: request.PathWaiterMatch, Argument: "CodeReview.State", + Expected: "Pending", + }, + }, + Logger: c.Config.Logger, + NewRequest: func(opts []request.Option) (*request.Request, error) { + var inCpy *DescribeCodeReviewInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeCodeReviewRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + w.ApplyOptions(opts...) + + return w.WaitWithContext(ctx) +} + +// WaitUntilRepositoryAssociationSucceeded uses the CodeGuruReviewer API operation +// DescribeRepositoryAssociation to wait for a condition to be met before returning. +// If the condition is not met within the max attempt window, an error will +// be returned. +func (c *CodeGuruReviewer) WaitUntilRepositoryAssociationSucceeded(input *DescribeRepositoryAssociationInput) error { + return c.WaitUntilRepositoryAssociationSucceededWithContext(aws.BackgroundContext(), input) +} + +// WaitUntilRepositoryAssociationSucceededWithContext is an extended version of WaitUntilRepositoryAssociationSucceeded. +// With the support for passing in a context and options to configure the +// Waiter and the underlying request options. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *CodeGuruReviewer) WaitUntilRepositoryAssociationSucceededWithContext(ctx aws.Context, input *DescribeRepositoryAssociationInput, opts ...request.WaiterOption) error { + w := request.Waiter{ + Name: "WaitUntilRepositoryAssociationSucceeded", + MaxAttempts: 20, + Delay: request.ConstantWaiterDelay(10 * time.Second), + Acceptors: []request.WaiterAcceptor{ + { + State: request.SuccessWaiterState, + Matcher: request.PathWaiterMatch, Argument: "RepositoryAssociation.State", + Expected: "Associated", + }, + { + State: request.RetryWaiterState, + Matcher: request.PathWaiterMatch, Argument: "RepositoryAssociation.State", + Expected: "Associating", + }, + }, + Logger: c.Config.Logger, + NewRequest: func(opts []request.Option) (*request.Request, error) { + var inCpy *DescribeRepositoryAssociationInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.DescribeRepositoryAssociationRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + w.ApplyOptions(opts...) + + return w.WaitWithContext(ctx) +} diff --git a/service/docdb/api.go b/service/docdb/api.go index 4b8a5e53bd0..494c4063635 100644 --- a/service/docdb/api.go +++ b/service/docdb/api.go @@ -142,8 +142,8 @@ func (c *DocDB) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *re // // Adds metadata tags to an Amazon DocumentDB resource. You can use these tags // with cost allocation reporting to track costs that are associated with Amazon -// DocumentDB resources. or in a Condition statement in an AWS Identity and -// Access Management (IAM) policy for Amazon DocumentDB. +// DocumentDB resources or in a Condition statement in an Identity and Access +// Management (IAM) policy for Amazon DocumentDB. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -404,7 +404,7 @@ func (c *DocDB) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) // To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier // must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You // can only copy a shared DB cluster snapshot, whether encrypted or not, in -// the same AWS Region. +// the same Region. // // To cancel the copy operation after it is in progress, delete the target cluster // snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster @@ -434,7 +434,7 @@ func (c *DocDB) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) // The request would cause you to exceed the allowed number of snapshots. // // * ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" -// An error occurred when accessing an AWS KMS key. +// An error occurred when accessing an KMS key. // // See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshot func (c *DocDB) CopyDBClusterSnapshot(input *CopyDBClusterSnapshotInput) (*CopyDBClusterSnapshotOutput, error) { @@ -553,7 +553,7 @@ func (c *DocDB) CreateDBClusterRequest(input *CreateDBClusterInput) (req *reques // group. // // * ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" -// An error occurred when accessing an AWS KMS key. +// An error occurred when accessing an KMS key. // // * ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" // DBClusterIdentifier doesn't refer to an existing cluster. @@ -887,7 +887,7 @@ func (c *DocDB) CreateDBInstanceRequest(input *CreateDBInstanceInput) (req *requ // on your behalf using IAM. // // * ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" -// An error occurred when accessing an AWS KMS key. +// An error occurred when accessing an KMS key. // // See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstance func (c *DocDB) CreateDBInstance(input *CreateDBInstanceInput) (*CreateDBInstanceOutput, error) { @@ -956,7 +956,7 @@ func (c *DocDB) CreateDBSubnetGroupRequest(input *CreateDBSubnetGroupInput) (req // CreateDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility. // // Creates a new subnet group. subnet groups must contain at least one subnet -// in at least two Availability Zones in the AWS Region. +// in at least two Availability Zones in the Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1168,7 +1168,7 @@ func (c *DocDB) CreateGlobalClusterRequest(input *CreateGlobalClusterInput) (req // CreateGlobalCluster API operation for Amazon DocumentDB with MongoDB compatibility. // // Creates an Amazon DocumentDB global cluster that can span multiple multiple -// AWS Regions. The global cluster contains one primary cluster with read-write +// Regions. The global cluster contains one primary cluster with read-write // capability, and up-to give read-only secondary clusters. Global clusters // uses storage-based fast replication across regions with latencies less than // one second, using dedicated infrastructure with no impact to your workload’s @@ -1886,7 +1886,7 @@ func (c *DocDB) DescribeCertificatesRequest(input *DescribeCertificatesInput) (r // DescribeCertificates API operation for Amazon DocumentDB with MongoDB compatibility. // // Returns a list of certificate authority (CA) certificates provided by Amazon -// DocumentDB for this AWS account. +// DocumentDB for this account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2296,11 +2296,11 @@ func (c *DocDB) DescribeDBClusterSnapshotAttributesRequest(input *DescribeDBClus // Returns a list of cluster snapshot attribute names and values for a manual // DB cluster snapshot. // -// When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes -// returns the restore attribute and a list of IDs for the AWS accounts that -// are authorized to copy or restore the manual cluster snapshot. If all is -// included in the list of values for the restore attribute, then the manual -// cluster snapshot is public and can be copied or restored by all AWS accounts. +// When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes +// returns the restore attribute and a list of IDs for the accounts that are +// authorized to copy or restore the manual cluster snapshot. If all is included +// in the list of values for the restore attribute, then the manual cluster +// snapshot is public and can be copied or restored by all accounts. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4293,18 +4293,18 @@ func (c *DocDB) ModifyDBClusterSnapshotAttributeRequest(input *ModifyDBClusterSn // ModifyDBClusterSnapshotAttribute API operation for Amazon DocumentDB with MongoDB compatibility. // // Adds an attribute and values to, or removes an attribute and values from, -// a manual DB cluster snapshot. -// -// To share a manual cluster snapshot with other AWS accounts, specify restore -// as the AttributeName, and use the ValuesToAdd parameter to add a list of -// IDs of the AWS accounts that are authorized to restore the manual cluster -// snapshot. Use the value all to make the manual cluster snapshot public, which -// means that it can be copied or restored by all AWS accounts. Do not add the -// all value for any manual DB cluster snapshots that contain private information -// that you don't want available to all AWS accounts. If a manual cluster snapshot -// is encrypted, it can be shared, but only by specifying a list of authorized -// AWS account IDs for the ValuesToAdd parameter. You can't use all as a value -// for that parameter in this case. +// a manual cluster snapshot. +// +// To share a manual cluster snapshot with other accounts, specify restore as +// the AttributeName, and use the ValuesToAdd parameter to add a list of IDs +// of the accounts that are authorized to restore the manual cluster snapshot. +// Use the value all to make the manual cluster snapshot public, which means +// that it can be copied or restored by all accounts. Do not add the all value +// for any manual cluster snapshots that contain private information that you +// don't want available to all accounts. If a manual cluster snapshot is encrypted, +// it can be shared, but only by specifying a list of authorized account IDs +// for the ValuesToAdd parameter. You can't use all as a value for that parameter +// in this case. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4514,7 +4514,7 @@ func (c *DocDB) ModifyDBSubnetGroupRequest(input *ModifyDBSubnetGroupInput) (req // ModifyDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility. // // Modifies an existing subnet group. subnet groups must contain at least one -// subnet in at least two Availability Zones in the AWS Region. +// subnet in at least two Availability Zones in the Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5300,7 +5300,7 @@ func (c *DocDB) RestoreDBClusterFromSnapshotRequest(input *RestoreDBClusterFromS // are not all in a common virtual private cloud (VPC). // // * ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" -// An error occurred when accessing an AWS KMS key. +// An error occurred when accessing an KMS key. // // See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot func (c *DocDB) RestoreDBClusterFromSnapshot(input *RestoreDBClusterFromSnapshotInput) (*RestoreDBClusterFromSnapshotOutput, error) { @@ -5428,7 +5428,7 @@ func (c *DocDB) RestoreDBClusterToPointInTimeRequest(input *RestoreDBClusterToPo // because of changes that were made. // // * ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" -// An error occurred when accessing an AWS KMS key. +// An error occurred when accessing an KMS key. // // * ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" // The request would cause you to exceed the allowed amount of storage available @@ -5912,7 +5912,7 @@ func (s *AvailabilityZone) SetName(v string) *AvailabilityZone { return s } -// A certificate authority (CA) certificate for an AWS account. +// A certificate authority (CA) certificate for an account. type Certificate struct { _ struct{} `type:"structure"` @@ -6040,12 +6040,12 @@ type CopyDBClusterParameterGroupInput struct { // // * Must specify a valid cluster parameter group. // - // * If the source cluster parameter group is in the same AWS Region as the - // copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, + // * If the source cluster parameter group is in the same Region as the copy, + // specify a valid parameter group identifier; for example, my-db-cluster-param-group, // or a valid ARN. // - // * If the source parameter group is in a different AWS Region than the - // copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group. + // * If the source parameter group is in a different Region than the copy, + // specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group. // // SourceDBClusterParameterGroupIdentifier is a required field SourceDBClusterParameterGroupIdentifier *string `type:"string" required:"true"` @@ -6163,40 +6163,40 @@ type CopyDBClusterSnapshotInput struct { // DestinationRegion is used for presigning the request to a given region. DestinationRegion *string `type:"string"` - // The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID - // is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS - // key alias for the AWS KMS encryption key. + // The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon + // Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS + // encryption key. // - // If you copy an encrypted cluster snapshot from your AWS account, you can - // specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption - // key. If you don't specify a value for KmsKeyId, then the copy of the cluster - // snapshot is encrypted with the same AWS KMS key as the source cluster snapshot. + // If you copy an encrypted cluster snapshot from your account, you can specify + // a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If + // you don't specify a value for KmsKeyId, then the copy of the cluster snapshot + // is encrypted with the same KMS key as the source cluster snapshot. // - // If you copy an encrypted cluster snapshot that is shared from another AWS - // account, then you must specify a value for KmsKeyId. + // If you copy an encrypted cluster snapshot that is shared from another account, + // then you must specify a value for KmsKeyId. // - // To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId - // to the AWS KMS key ID that you want to use to encrypt the copy of the cluster - // snapshot in the destination Region. AWS KMS encryption keys are specific - // to the AWS Region that they are created in, and you can't use encryption - // keys from one AWS Region in another AWS Region. + // To copy an encrypted cluster snapshot to another Region, set KmsKeyId to + // the KMS key ID that you want to use to encrypt the copy of the cluster snapshot + // in the destination Region. KMS encryption keys are specific to the Region + // that they are created in, and you can't use encryption keys from one Region + // in another Region. // // If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId // parameter, an error is returned. KmsKeyId *string `type:"string"` - // The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot - // API action in the AWS Region that contains the source cluster snapshot to - // copy. You must use the PreSignedUrl parameter when copying a cluster snapshot - // from another AWS Region. + // The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot + // API action in the Region that contains the source cluster snapshot to copy. + // You must use the PreSignedUrl parameter when copying a cluster snapshot from + // another Region. // - // If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion - // (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. - // Specifying SourceRegion autogenerates a pre-signed URL that is a valid request - // for the operation that can be executed in the source AWS Region. + // If you are using an Amazon Web Services SDK tool or the CLI, you can specify + // SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl + // manually. Specifying SourceRegion autogenerates a pre-signed URL that is + // a valid request for the operation that can be executed in the source Region. // // The presigned URL must be a valid request for the CopyDBClusterSnapshot API - // action that can be executed in the source AWS Region that contains the cluster + // action that can be executed in the source Region that contains the cluster // snapshot to be copied. The presigned URL request must contain the following // parameter values: // @@ -6205,10 +6205,9 @@ type CopyDBClusterSnapshotInput struct { // // * SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted // cluster snapshot to be copied. This identifier must be in the Amazon Resource - // Name (ARN) format for the source AWS Region. For example, if you are copying - // an encrypted cluster snapshot from the us-east-1 AWS Region, then your - // SourceDBClusterSnapshotIdentifier looks something like the following: - // arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot. + // Name (ARN) format for the source Region. For example, if you are copying + // an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier + // looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot. // // * TargetDBClusterSnapshotIdentifier - The identifier for the new cluster // snapshot to be created. This parameter isn't case sensitive. @@ -6221,10 +6220,10 @@ type CopyDBClusterSnapshotInput struct { // // * Must specify a valid system snapshot in the available state. // - // * If the source snapshot is in the same AWS Region as the copy, specify - // a valid snapshot identifier. + // * If the source snapshot is in the same Region as the copy, specify a + // valid snapshot identifier. // - // * If the source snapshot is in a different AWS Region than the copy, specify + // * If the source snapshot is in a different Region than the copy, specify // a valid cluster snapshot ARN. // // Example: my-cluster-snapshot1 @@ -6429,21 +6428,20 @@ type CreateDBClusterInput struct { // The cluster identifier of the new global cluster. GlobalClusterIdentifier *string `min:"1" type:"string"` - // The AWS KMS key identifier for an encrypted cluster. + // The KMS key identifier for an encrypted cluster. // - // The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS - // KMS encryption key. If you are creating a cluster using the same AWS account - // that owns the AWS KMS encryption key that is used to encrypt the new cluster, - // you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption - // key. + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are creating a cluster using the same account that owns the KMS + // encryption key that is used to encrypt the new cluster, you can use the KMS + // key alias instead of the ARN for the KMS encryption key. // // If an encryption key is not specified in KmsKeyId: // // * If the StorageEncrypted parameter is true, Amazon DocumentDB uses your // default encryption key. // - // AWS KMS creates the default encryption key for your AWS account. Your AWS - // account has a different default encryption key for each AWS Region. + // KMS creates the default encryption key for your account. Your account has + // a different default encryption key for each Regions. KmsKeyId *string `type:"string"` // The password for the master database user. This password can contain any @@ -6474,7 +6472,7 @@ type CreateDBClusterInput struct { // backups are enabled using the BackupRetentionPeriod parameter. // // The default is a 30-minute window selected at random from an 8-hour block - // of time for each AWS Region. + // of time for each Region. // // Constraints: // @@ -6493,7 +6491,7 @@ type CreateDBClusterInput struct { // Format: ddd:hh24:mi-ddd:hh24:mi // // The default is a 30-minute window selected at random from an 8-hour block - // of time for each AWS Region, occurring on a random day of the week. + // of time for each Region, occurring on a random day of the week. // // Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun // @@ -6911,16 +6909,15 @@ func (s *CreateDBClusterSnapshotOutput) SetDBClusterSnapshot(v *DBClusterSnapsho type CreateDBInstanceInput struct { _ struct{} `type:"structure"` - // Indicates that minor engine upgrades are applied automatically to the instance - // during the maintenance window. + // This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does + // not perform minor version upgrades regardless of the value set. // - // Default: true + // Default: false AutoMinorVersionUpgrade *bool `type:"boolean"` // The Amazon EC2 Availability Zone that the instance is created in. // - // Default: A random, system-chosen Availability Zone in the endpoint's AWS - // Region. + // Default: A random, system-chosen Availability Zone in the endpoint's Region. // // Example: us-east-1d AvailabilityZone *string `type:"string"` @@ -6963,7 +6960,7 @@ type CreateDBInstanceInput struct { // Format: ddd:hh24:mi-ddd:hh24:mi // // The default is a 30-minute window selected at random from an 8-hour block - // of time for each AWS Region, occurring on a random day of the week. + // of time for each Region, occurring on a random day of the week. // // Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun // @@ -7239,7 +7236,7 @@ type CreateEventSubscriptionInput struct { // to db-instance. If this value is not specified, all events are returned. // // Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, - // db-snapshot, db-cluster-snapshot + // db-cluster-snapshot SourceType *string `type:"string"` // The name of the subscription. @@ -7471,9 +7468,10 @@ func (s *CreateGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *CreateGl type DBCluster struct { _ struct{} `type:"structure"` - // Provides a list of the AWS Identity and Access Management (IAM) roles that - // are associated with the cluster. IAM roles that are associated with a cluster - // grant permission for the cluster to access other AWS services on your behalf. + // Provides a list of the Identity and Access Management (IAM) roles that are + // associated with the cluster. (IAM) roles that are associated with a cluster + // grant permission for the cluster to access other Amazon Web Services services + // on your behalf. AssociatedRoles []*DBClusterRole `locationNameList:"DBClusterRole" type:"list"` // Provides the list of Amazon EC2 Availability Zones that instances in the @@ -7504,9 +7502,9 @@ type DBCluster struct { // including the name, description, and subnets in the subnet group. DBSubnetGroup *string `type:"string"` - // The AWS Region-unique, immutable identifier for the cluster. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster - // is accessed. + // The Region-unique, immutable identifier for the cluster. This identifier + // is found in CloudTrail log entries whenever the KMS key for the cluster is + // accessed. DbClusterResourceId *string `type:"string"` // Specifies whether this cluster can be deleted. If DeletionProtection is enabled, @@ -7535,8 +7533,7 @@ type DBCluster struct { // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string `type:"string"` - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted - // cluster. + // If StorageEncrypted is true, the KMS key identifier for the encrypted cluster. KmsKeyId *string `type:"string"` // Specifies the latest time to which a database can be restored with point-in-time @@ -7898,25 +7895,26 @@ func (s *DBClusterParameterGroup) SetDescription(v string) *DBClusterParameterGr return s } -// Describes an AWS Identity and Access Management (IAM) role that is associated +// Describes an Identity and Access Management (IAM) role that is associated // with a cluster. type DBClusterRole struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the IAM role that is associated with the + // The Amazon Resource Name (ARN) of the IAMrole that is associated with the // DB cluster. RoleArn *string `type:"string"` - // Describes the state of association between the IAM role and the cluster. - // The Status property returns one of the following values: + // Describes the state of association between the IAMrole and the cluster. The + // Status property returns one of the following values: // - // * ACTIVE - The IAM role ARN is associated with the cluster and can be - // used to access other AWS services on your behalf. + // * ACTIVE - The IAMrole ARN is associated with the cluster and can be used + // to access other Amazon Web Services services on your behalf. // - // * PENDING - The IAM role ARN is being associated with the DB cluster. + // * PENDING - The IAMrole ARN is being associated with the cluster. // - // * INVALID - The IAM role ARN is associated with the cluster, but the cluster - // cannot assume the IAM role to access other AWS services on your behalf. + // * INVALID - The IAMrole ARN is associated with the cluster, but the cluster + // cannot assume the IAMrole to access other Amazon Web Services services + // on your behalf. Status *string `type:"string"` } @@ -7970,8 +7968,8 @@ type DBClusterSnapshot struct { // Provides the version of the database engine for this cluster snapshot. EngineVersion *string `type:"string"` - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted - // cluster snapshot. + // If StorageEncrypted is true, the KMS key identifier for the encrypted cluster + // snapshot. KmsKeyId *string `type:"string"` // Provides the master user name for the cluster snapshot. @@ -8118,23 +8116,23 @@ func (s *DBClusterSnapshot) SetVpcId(v string) *DBClusterSnapshot { // Contains the name and values of a manual cluster snapshot attribute. // -// Manual cluster snapshot attributes are used to authorize other AWS accounts -// to restore a manual cluster snapshot. +// Manual cluster snapshot attributes are used to authorize other accounts to +// restore a manual cluster snapshot. type DBClusterSnapshotAttribute struct { _ struct{} `type:"structure"` // The name of the manual cluster snapshot attribute. // - // The attribute named restore refers to the list of AWS accounts that have - // permission to copy or restore the manual cluster snapshot. + // The attribute named restore refers to the list of accounts that have permission + // to copy or restore the manual cluster snapshot. AttributeName *string `type:"string"` // The values for the manual cluster snapshot attribute. // // If the AttributeName field is set to restore, then this element returns a - // list of IDs of the AWS accounts that are authorized to copy or restore the - // manual cluster snapshot. If a value of all is in the list, then the manual - // cluster snapshot is public and available for any AWS account to copy or restore. + // list of IDs of the accounts that are authorized to copy or restore the manual + // cluster snapshot. If a value of all is in the list, then the manual cluster + // snapshot is public and available for any account to copy or restore. AttributeValues []*string `locationNameList:"AttributeValue" type:"list"` } @@ -8288,7 +8286,9 @@ func (s *DBEngineVersion) SetValidUpgradeTarget(v []*UpgradeTarget) *DBEngineVer type DBInstance struct { _ struct{} `type:"structure"` - // Indicates that minor version patches are applied automatically. + // Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon + // DocumentDB does not perform minor version upgrades regardless of the value + // set. AutoMinorVersionUpgrade *bool `type:"boolean"` // Specifies the name of the Availability Zone that the instance is located @@ -8322,13 +8322,13 @@ type DBInstance struct { // including the name, description, and subnets in the subnet group. DBSubnetGroup *DBSubnetGroup `type:"structure"` - // The AWS Region-unique, immutable identifier for the instance. This identifier - // is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance + // The Region-unique, immutable identifier for the instance. This identifier + // is found in CloudTrail log entries whenever the KMS key for the instance // is accessed. DbiResourceId *string `type:"string"` - // A list of log types that this instance is configured to export to Amazon - // CloudWatch Logs. + // A list of log types that this instance is configured to export to CloudWatch + // Logs. EnabledCloudwatchLogsExports []*string `type:"list"` // Specifies the connection endpoint. @@ -8343,8 +8343,7 @@ type DBInstance struct { // Provides the date and time that the instance was created. InstanceCreateTime *time.Time `type:"timestamp"` - // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted - // instance. + // If StorageEncrypted is true, the KMS key identifier for the encrypted instance. KmsKeyId *string `type:"string"` // Specifies the latest time to which a database can be restored with point-in-time @@ -9251,7 +9250,7 @@ func (s *DescribeCertificatesInput) SetMaxRecords(v int64) *DescribeCertificates type DescribeCertificatesOutput struct { _ struct{} `type:"structure"` - // A list of certificates for this AWS account. + // A list of certificates for this account. Certificates []*Certificate `locationNameList:"Certificate" type:"list"` // An optional pagination token provided if the number of records retrieved @@ -9627,12 +9626,11 @@ type DescribeDBClusterSnapshotsInput struct { Filters []*Filter `locationNameList:"Filter" type:"list"` // Set to true to include manual cluster snapshots that are public and can be - // copied or restored by any AWS account, and otherwise false. The default is - // false. + // copied or restored by any account, and otherwise false. The default is false. IncludePublic *bool `type:"boolean"` - // Set to true to include shared manual cluster snapshots from other AWS accounts - // that this AWS account has been given permission to copy or restore, and otherwise + // Set to true to include shared manual cluster snapshots from other accounts + // that this account has been given permission to copy or restore, and otherwise // false. The default is false. IncludeShared *bool `type:"boolean"` @@ -9654,13 +9652,13 @@ type DescribeDBClusterSnapshotsInput struct { // following values: // // * automated - Return all cluster snapshots that Amazon DocumentDB has - // automatically created for your AWS account. + // automatically created for your account. // // * manual - Return all cluster snapshots that you have manually created - // for your AWS account. + // for your account. // // * shared - Return all manual cluster snapshots that have been shared to - // your AWS account. + // your account. // // * public - Return all cluster snapshots that have been marked as public. // @@ -10447,7 +10445,7 @@ type DescribeEventCategoriesInput struct { // The type of source that is generating the events. // - // Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot + // Valid values: db-instance, db-parameter-group, db-security-group SourceType *string `type:"string"` } @@ -11412,8 +11410,8 @@ type EventSubscription struct { // The Amazon DocumentDB event notification subscription ID. CustSubscriptionId *string `type:"string"` - // The AWS customer account that is associated with the Amazon DocumentDB event - // notification subscription. + // The Amazon Web Services customer account that is associated with the Amazon + // DocumentDB event notification subscription. CustomerAwsId *string `type:"string"` // A Boolean value indicating whether the subscription is enabled. A value of @@ -11670,7 +11668,7 @@ type GlobalCluster struct { // Currently limited to one item. GlobalClusterMembers []*GlobalClusterMember `locationNameList:"GlobalClusterMember" type:"list"` - // The AWS Region-unique, immutable identifier for the global database cluster. + // The Region-unique, immutable identifier for the global database cluster. // This identifier is found in AWS CloudTrail log entries whenever the AWS KMS // customer master key (CMK) for the cluster is accessed. GlobalClusterResourceId *string `type:"string"` @@ -11971,7 +11969,7 @@ type ModifyDBClusterInput struct { // backups are enabled, using the BackupRetentionPeriod parameter. // // The default is a 30-minute window selected at random from an 8-hour block - // of time for each AWS Region. + // of time for each Region. // // Constraints: // @@ -11990,7 +11988,7 @@ type ModifyDBClusterInput struct { // Format: ddd:hh24:mi-ddd:hh24:mi // // The default is a 30-minute window selected at random from an 8-hour block - // of time for each AWS Region, occurring on a random day of the week. + // of time for each Region, occurring on a random day of the week. // // Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun // @@ -12219,8 +12217,8 @@ type ModifyDBClusterSnapshotAttributeInput struct { // The name of the cluster snapshot attribute to modify. // - // To manage authorization for other AWS accounts to copy or restore a manual - // cluster snapshot, set this value to restore. + // To manage authorization for other accounts to copy or restore a manual cluster + // snapshot, set this value to restore. // // AttributeName is a required field AttributeName *string `type:"string" required:"true"` @@ -12233,22 +12231,22 @@ type ModifyDBClusterSnapshotAttributeInput struct { // A list of cluster snapshot attributes to add to the attribute specified by // AttributeName. // - // To authorize other AWS accounts to copy or restore a manual cluster snapshot, - // set this list to include one or more AWS account IDs. To make the manual - // cluster snapshot restorable by any AWS account, set it to all. Do not add - // the all value for any manual cluster snapshots that contain private information - // that you don't want to be available to all AWS accounts. + // To authorize other accounts to copy or restore a manual cluster snapshot, + // set this list to include one or more account IDs. To make the manual cluster + // snapshot restorable by any account, set it to all. Do not add the all value + // for any manual cluster snapshots that contain private information that you + // don't want to be available to all accounts. ValuesToAdd []*string `locationNameList:"AttributeValue" type:"list"` // A list of cluster snapshot attributes to remove from the attribute specified // by AttributeName. // - // To remove authorization for other AWS accounts to copy or restore a manual - // cluster snapshot, set this list to include one or more AWS account identifiers. - // To remove authorization for any AWS account to copy or restore the cluster - // snapshot, set it to all . If you specify all, an AWS account whose account - // ID is explicitly added to the restore attribute can still copy or restore - // a manual cluster snapshot. + // To remove authorization for other accounts to copy or restore a manual cluster + // snapshot, set this list to include one or more account identifiers. To remove + // authorization for any account to copy or restore the cluster snapshot, set + // it to all . If you specify all, an account whose account ID is explicitly + // added to the restore attribute can still copy or restore a manual cluster + // snapshot. ValuesToRemove []*string `locationNameList:"AttributeValue" type:"list"` } @@ -12341,19 +12339,15 @@ type ModifyDBInstanceInput struct { // Default: false ApplyImmediately *bool `type:"boolean"` - // Indicates that minor version upgrades are applied automatically to the instance - // during the maintenance window. Changing this parameter doesn't result in - // an outage except in the following case, and the change is asynchronously - // applied as soon as possible. An outage results if this parameter is set to - // true during the maintenance window, and a newer minor version is available, - // and Amazon DocumentDB has enabled automatic patching for that engine version. + // This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does + // not perform minor version upgrades regardless of the value set. AutoMinorVersionUpgrade *bool `type:"boolean"` // Indicates the certificate that needs to be associated with the instance. CACertificateIdentifier *string `type:"string"` // The new compute and memory capacity of the instance; for example, db.r5.large. - // Not all instance classes are available in all AWS Regions. + // Not all instance classes are available in all Regions. // // If you modify the instance class, an outage occurs during the change. The // change is applied during the next maintenance window, unless ApplyImmediately @@ -12620,7 +12614,7 @@ type ModifyEventSubscriptionInput struct { // to be notified of events generated by an instance, set this parameter to // db-instance. If this value is not specified, all events are returned. // - // Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot + // Valid values: db-instance, db-parameter-group, db-security-group SourceType *string `type:"string"` // The name of the Amazon DocumentDB event notification subscription. @@ -13729,21 +13723,20 @@ type RestoreDBClusterFromSnapshotInput struct { // The version of the database engine to use for the new cluster. EngineVersion *string `type:"string"` - // The AWS KMS key identifier to use when restoring an encrypted cluster from - // a DB snapshot or cluster snapshot. + // The KMS key identifier to use when restoring an encrypted cluster from a + // DB snapshot or cluster snapshot. // - // The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS - // KMS encryption key. If you are restoring a cluster with the same AWS account - // that owns the AWS KMS encryption key used to encrypt the new cluster, then - // you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption - // key. + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are restoring a cluster with the same account that owns the KMS + // encryption key used to encrypt the new cluster, then you can use the KMS + // key alias instead of the ARN for the KMS encryption key. // // If you do not specify a value for the KmsKeyId parameter, then the following // occurs: // // * If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, - // then the restored cluster is encrypted using the AWS KMS key that was - // used to encrypt the snapshot or the cluster snapshot. + // then the restored cluster is encrypted using the KMS key that was used + // to encrypt the snapshot or the cluster snapshot. // // * If the snapshot or the cluster snapshot in SnapshotIdentifier is not // encrypted, then the restored DB cluster is not encrypted. @@ -13934,25 +13927,24 @@ type RestoreDBClusterToPointInTimeInput struct { // Logs. EnableCloudwatchLogsExports []*string `type:"list"` - // The AWS KMS key identifier to use when restoring an encrypted cluster from - // an encrypted cluster. + // The KMS key identifier to use when restoring an encrypted cluster from an + // encrypted cluster. // - // The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS - // KMS encryption key. If you are restoring a cluster with the same AWS account - // that owns the AWS KMS encryption key used to encrypt the new cluster, then - // you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption - // key. + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are restoring a cluster with the same account that owns the KMS + // encryption key used to encrypt the new cluster, then you can use the KMS + // key alias instead of the ARN for the KMS encryption key. // - // You can restore to a new cluster and encrypt the new cluster with an AWS - // KMS key that is different from the AWS KMS key used to encrypt the source - // cluster. The new DB cluster is encrypted with the AWS KMS key identified - // by the KmsKeyId parameter. + // You can restore to a new cluster and encrypt the new cluster with an KMS + // key that is different from the KMS key used to encrypt the source cluster. + // The new DB cluster is encrypted with the KMS key identified by the KmsKeyId + // parameter. // // If you do not specify a value for the KmsKeyId parameter, then the following // occurs: // // * If the cluster is encrypted, then the restored cluster is encrypted - // using the AWS KMS key that was used to encrypt the source cluster. + // using the KMS key that was used to encrypt the source cluster. // // * If the cluster is not encrypted, then the restored cluster is not encrypted. // diff --git a/service/docdb/errors.go b/service/docdb/errors.go index 35ece529e85..247184bb873 100644 --- a/service/docdb/errors.go +++ b/service/docdb/errors.go @@ -284,7 +284,7 @@ const ( // ErrCodeKMSKeyNotAccessibleFault for service response error code // "KMSKeyNotAccessibleFault". // - // An error occurred when accessing an AWS KMS key. + // An error occurred when accessing an KMS key. ErrCodeKMSKeyNotAccessibleFault = "KMSKeyNotAccessibleFault" // ErrCodeResourceNotFoundFault for service response error code diff --git a/service/ec2/api.go b/service/ec2/api.go index 425ed079275..42c06eba446 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -105974,6 +105974,9 @@ type ProvisionByoipCidrInput struct { // it is UnauthorizedOperation. DryRun *bool `type:"boolean"` + // Reserved. + MultiRegion *bool `type:"boolean"` + // The tags to apply to the address pool. PoolTagSpecifications []*TagSpecification `locationName:"PoolTagSpecification" locationNameList:"item" type:"list"` @@ -106036,6 +106039,12 @@ func (s *ProvisionByoipCidrInput) SetDryRun(v bool) *ProvisionByoipCidrInput { return s } +// SetMultiRegion sets the MultiRegion field's value. +func (s *ProvisionByoipCidrInput) SetMultiRegion(v bool) *ProvisionByoipCidrInput { + s.MultiRegion = &v + return s +} + // SetPoolTagSpecifications sets the PoolTagSpecifications field's value. func (s *ProvisionByoipCidrInput) SetPoolTagSpecifications(v []*TagSpecification) *ProvisionByoipCidrInput { s.PoolTagSpecifications = v diff --git a/service/eventbridge/api.go b/service/eventbridge/api.go index e83771867b6..009e69f36c8 100644 --- a/service/eventbridge/api.go +++ b/service/eventbridge/api.go @@ -1358,6 +1358,10 @@ func (c *EventBridge) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Re // When you delete a rule, incoming events might continue to match to the deleted // rule. Allow a short period of time for changes to take effect. // +// If you call delete rule multiple times for the same rule, all calls will +// succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException +// is returned. +// // Managed rules are rules created and managed by another AWS service on your // behalf. These rules are created by those other AWS services to support functionality // in those services. You can delete these rules using the Force option, but @@ -3763,43 +3767,55 @@ func (c *EventBridge) PutTargetsRequest(input *PutTargetsInput) (req *request.Re // // You can configure the following as targets for Events: // -// * EC2 instances +// * API destination (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) // -// * SSM Run Command +// * Amazon API Gateway REST API endpoints // -// * SSM Automation +// * API Gateway +// +// * AWS Batch job queue +// +// * CloudWatch Logs group +// +// * CodeBuild project // -// * AWS Lambda functions +// * CodePineline // -// * Data streams in Amazon Kinesis Data Streams +// * Amazon EC2 CreateSnapshot API call // -// * Data delivery streams in Amazon Kinesis Data Firehose +// * Amazon EC2 RebootInstances API call +// +// * Amazon EC2 StopInstances API call +// +// * Amazon EC2 TerminateInstances API call // // * Amazon ECS tasks // -// * AWS Step Functions state machines +// * Event bus in a different AWS account or Region. You can use an event +// bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, +// or Europe (Ireland) eu-west-1 Regions as a target for a rule. // -// * AWS Batch jobs +// * Firehose delivery stream (Kinesis Data Firehose) // -// * AWS CodeBuild projects +// * Inspector assessment template (Amazon Inspector) // -// * Pipelines in AWS CodePipeline +// * Kinesis stream (Kinesis Data Stream) // -// * Amazon Inspector assessment templates +// * AWS Lambda function // -// * Amazon SNS topics +// * Redshift clusters (Data API statement execution) // -// * Amazon SQS queues, including FIFO queues +// * Amazon SNS topic // -// * The default event bus of another AWS account +// * Amazon SQS queues (includes FIFO queues // -// * Amazon API Gateway REST APIs +// * SSM Automation // -// * Redshift Clusters to invoke Data API ExecuteStatement on +// * SSM OpsItem // -// * Custom/SaaS HTTPS APIs via EventBridge API Destinations +// * SSM Run Command // -// * Amazon SageMaker Model Building Pipelines +// * Step Functions state machines // // Creating rules with built-in targets is supported only in the AWS Management // Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances @@ -4461,7 +4477,7 @@ func (c *EventBridge) UntagResourceRequest(input *UntagResourceInput) (req *requ // UntagResource API operation for Amazon EventBridge. // // Removes one or more tags from the specified EventBridge resource. In Amazon -// EventBridge (CloudWatch Events, rules and event buses can be tagged. +// EventBridge (CloudWatch Events), rules and event buses can be tagged. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5300,6 +5316,73 @@ func (s *CancelReplayOutput) SetStateReason(v string) *CancelReplayOutput { return s } +// The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem +// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) +// in the Amazon ECS API Reference. +type CapacityProviderStrategyItem struct { + _ struct{} `type:"structure"` + + // The base value designates how many tasks, at a minimum, to run on the specified + // capacity provider. Only one capacity provider in a capacity provider strategy + // can have a base defined. If no value is specified, the default value of 0 + // is used. + Base *int64 `locationName:"base" type:"integer"` + + // The short name of the capacity provider. + // + // CapacityProvider is a required field + CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true"` + + // The weight value designates the relative percentage of the total number of + // tasks launched that should use the specified capacity provider. The weight + // value is taken into consideration after the base value, if defined, is satisfied. + Weight *int64 `locationName:"weight" type:"integer"` +} + +// String returns the string representation +func (s CapacityProviderStrategyItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CapacityProviderStrategyItem) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CapacityProviderStrategyItem) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CapacityProviderStrategyItem"} + if s.CapacityProvider == nil { + invalidParams.Add(request.NewErrParamRequired("CapacityProvider")) + } + if s.CapacityProvider != nil && len(*s.CapacityProvider) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CapacityProvider", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBase sets the Base field's value. +func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem { + s.Base = &v + return s +} + +// SetCapacityProvider sets the CapacityProvider field's value. +func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem { + s.CapacityProvider = &v + return s +} + +// SetWeight sets the Weight field's value. +func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem { + s.Weight = &v + return s +} + // There is concurrent modification on a rule, target, archive, or replay. type ConcurrentModificationException struct { _ struct{} `type:"structure"` @@ -8576,6 +8659,23 @@ func (s DisableRuleOutput) GoString() string { type EcsParameters struct { _ struct{} `type:"structure"` + // The capacity provider strategy to use for the task. + // + // If a capacityProviderStrategy is specified, the launchType parameter must + // be omitted. If no capacityProviderStrategy or launchType is specified, the + // defaultCapacityProviderStrategy for the cluster is used. + CapacityProviderStrategy []*CapacityProviderStrategyItem `type:"list"` + + // Specifies whether to enable Amazon ECS managed tags for the task. For more + // information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) + // in the Amazon Elastic Container Service Developer Guide. + EnableECSManagedTags *bool `type:"boolean"` + + // Whether or not to enable the execute command functionality for the containers + // in this task. If true, this enables execute command functionality on all + // containers in the task. + EnableExecuteCommand *bool `type:"boolean"` + // Specifies an ECS task group for the task. The maximum length is 255 characters. Group *string `type:"string"` @@ -8596,6 +8696,15 @@ type EcsParameters struct { // the awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration `type:"structure"` + // An array of placement constraint objects to use for the task. You can specify + // up to 10 constraints per task (including constraints in the task definition + // and those specified at runtime). + PlacementConstraints []*PlacementConstraint `type:"list"` + + // The placement strategy objects to use for the task. You can specify a maximum + // of five strategy rules per task. + PlacementStrategy []*PlacementStrategy `type:"list"` + // Specifies the platform version for the task. Specify only the numeric portion // of the platform version, such as 1.1.0. // @@ -8604,6 +8713,21 @@ type EcsParameters struct { // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `type:"string"` + // Specifies whether to propagate the tags from the task definition to the task. + // If no value is specified, the tags are not propagated. Tags can only be propagated + // to the task during task creation. To add tags to a task after task creation, + // use the TagResource API action. + PropagateTags *string `type:"string" enum:"PropagateTags"` + + // The reference ID to use for the task. + ReferenceId *string `type:"string"` + + // The metadata that you apply to the task to help you categorize and organize + // them. Each tag consists of a key and an optional value, both of which you + // define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) + // in the Amazon ECS API Reference. + Tags []*Tag `type:"list"` + // The number of tasks to create based on TaskDefinition. The default is 1. TaskCount *int64 `min:"1" type:"integer"` @@ -8636,11 +8760,31 @@ func (s *EcsParameters) Validate() error { if s.TaskDefinitionArn != nil && len(*s.TaskDefinitionArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("TaskDefinitionArn", 1)) } + if s.CapacityProviderStrategy != nil { + for i, v := range s.CapacityProviderStrategy { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CapacityProviderStrategy", i), err.(request.ErrInvalidParams)) + } + } + } if s.NetworkConfiguration != nil { if err := s.NetworkConfiguration.Validate(); err != nil { invalidParams.AddNested("NetworkConfiguration", err.(request.ErrInvalidParams)) } } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -8648,6 +8792,24 @@ func (s *EcsParameters) Validate() error { return nil } +// SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value. +func (s *EcsParameters) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *EcsParameters { + s.CapacityProviderStrategy = v + return s +} + +// SetEnableECSManagedTags sets the EnableECSManagedTags field's value. +func (s *EcsParameters) SetEnableECSManagedTags(v bool) *EcsParameters { + s.EnableECSManagedTags = &v + return s +} + +// SetEnableExecuteCommand sets the EnableExecuteCommand field's value. +func (s *EcsParameters) SetEnableExecuteCommand(v bool) *EcsParameters { + s.EnableExecuteCommand = &v + return s +} + // SetGroup sets the Group field's value. func (s *EcsParameters) SetGroup(v string) *EcsParameters { s.Group = &v @@ -8666,12 +8828,42 @@ func (s *EcsParameters) SetNetworkConfiguration(v *NetworkConfiguration) *EcsPar return s } +// SetPlacementConstraints sets the PlacementConstraints field's value. +func (s *EcsParameters) SetPlacementConstraints(v []*PlacementConstraint) *EcsParameters { + s.PlacementConstraints = v + return s +} + +// SetPlacementStrategy sets the PlacementStrategy field's value. +func (s *EcsParameters) SetPlacementStrategy(v []*PlacementStrategy) *EcsParameters { + s.PlacementStrategy = v + return s +} + // SetPlatformVersion sets the PlatformVersion field's value. func (s *EcsParameters) SetPlatformVersion(v string) *EcsParameters { s.PlatformVersion = &v return s } +// SetPropagateTags sets the PropagateTags field's value. +func (s *EcsParameters) SetPropagateTags(v string) *EcsParameters { + s.PropagateTags = &v + return s +} + +// SetReferenceId sets the ReferenceId field's value. +func (s *EcsParameters) SetReferenceId(v string) *EcsParameters { + s.ReferenceId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *EcsParameters) SetTags(v []*Tag) *EcsParameters { + s.Tags = v + return s +} + // SetTaskCount sets the TaskCount field's value. func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters { s.TaskCount = &v @@ -8753,11 +8945,10 @@ func (s EnableRuleOutput) GoString() string { } // An event bus receives events from a source and routes them to rules associated -// with that event bus. Your account's default event bus receives rules from -// AWS services. A custom event bus can receive rules from AWS services as well -// as your custom applications and services. A partner event bus receives events -// from an event source created by an SaaS partner. These events come from the -// partners services or applications. +// with that event bus. Your account's default event bus receives events from +// AWS services. A custom event bus can receive events from your custom applications +// and services. A partner event bus receives events from an event source created +// by an SaaS partner. These events come from the partners services or applications. type EventBus struct { _ struct{} `type:"structure"` @@ -10829,6 +11020,92 @@ func (s *PartnerEventSourceAccount) SetState(v string) *PartnerEventSourceAccoun return s } +// An object representing a constraint on task placement. To learn more, see +// Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) +// in the Amazon Elastic Container Service Developer Guide. +type PlacementConstraint struct { + _ struct{} `type:"structure"` + + // A cluster query language expression to apply to the constraint. You cannot + // specify an expression if the constraint type is distinctInstance. To learn + // more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) + // in the Amazon Elastic Container Service Developer Guide. + Expression *string `locationName:"expression" type:"string"` + + // The type of constraint. Use distinctInstance to ensure that each task in + // a particular group is running on a different container instance. Use memberOf + // to restrict the selection to a group of valid candidates. + Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"` +} + +// String returns the string representation +func (s PlacementConstraint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PlacementConstraint) GoString() string { + return s.String() +} + +// SetExpression sets the Expression field's value. +func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint { + s.Expression = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementConstraint) SetType(v string) *PlacementConstraint { + s.Type = &v + return s +} + +// The task placement strategy for a task or service. To learn more, see Task +// Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) +// in the Amazon Elastic Container Service Developer Guide. +type PlacementStrategy struct { + _ struct{} `type:"structure"` + + // The field to apply the placement strategy against. For the spread placement + // strategy, valid values are instanceId (or host, which has the same effect), + // or any platform or custom attribute that is applied to a container instance, + // such as attribute:ecs.availability-zone. For the binpack placement strategy, + // valid values are cpu and memory. For the random placement strategy, this + // field is not used. + Field *string `locationName:"field" type:"string"` + + // The type of placement strategy. The random placement strategy randomly places + // tasks on available candidates. The spread placement strategy spreads placement + // across available candidates evenly based on the field parameter. The binpack + // strategy places tasks on available candidates that have the least available + // amount of the resource that is specified with the field parameter. For example, + // if you binpack on memory, a task is placed on the instance with the least + // amount of remaining memory (but still enough to run the task). + Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"` +} + +// String returns the string representation +func (s PlacementStrategy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PlacementStrategy) GoString() string { + return s.String() +} + +// SetField sets the Field field's value. +func (s *PlacementStrategy) SetField(v string) *PlacementStrategy { + s.Field = &v + return s +} + +// SetType sets the Type field's value. +func (s *PlacementStrategy) SetType(v string) *PlacementStrategy { + s.Type = &v + return s +} + // The event bus policy is too long. For more information, see the limits. type PolicyLengthExceededException struct { _ struct{} `type:"structure"` @@ -14399,6 +14676,54 @@ func LaunchType_Values() []string { } } +const ( + // PlacementConstraintTypeDistinctInstance is a PlacementConstraintType enum value + PlacementConstraintTypeDistinctInstance = "distinctInstance" + + // PlacementConstraintTypeMemberOf is a PlacementConstraintType enum value + PlacementConstraintTypeMemberOf = "memberOf" +) + +// PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum +func PlacementConstraintType_Values() []string { + return []string{ + PlacementConstraintTypeDistinctInstance, + PlacementConstraintTypeMemberOf, + } +} + +const ( + // PlacementStrategyTypeRandom is a PlacementStrategyType enum value + PlacementStrategyTypeRandom = "random" + + // PlacementStrategyTypeSpread is a PlacementStrategyType enum value + PlacementStrategyTypeSpread = "spread" + + // PlacementStrategyTypeBinpack is a PlacementStrategyType enum value + PlacementStrategyTypeBinpack = "binpack" +) + +// PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum +func PlacementStrategyType_Values() []string { + return []string{ + PlacementStrategyTypeRandom, + PlacementStrategyTypeSpread, + PlacementStrategyTypeBinpack, + } +} + +const ( + // PropagateTagsTaskDefinition is a PropagateTags enum value + PropagateTagsTaskDefinition = "TASK_DEFINITION" +) + +// PropagateTags_Values returns all elements of the PropagateTags enum +func PropagateTags_Values() []string { + return []string{ + PropagateTagsTaskDefinition, + } +} + const ( // ReplayStateStarting is a ReplayState enum value ReplayStateStarting = "STARTING" diff --git a/service/licensemanager/api.go b/service/licensemanager/api.go index 2f197e474d5..9cb2d65571d 100644 --- a/service/licensemanager/api.go +++ b/service/licensemanager/api.go @@ -170,6 +170,9 @@ func (c *LicenseManager) CheckInLicenseRequest(input *CheckInLicenseInput) (req // * ValidationException // The provided input is not valid. Try your request again. // +// * InvalidParameterValueException +// One or more parameter values are not valid. +// // * ResourceNotFoundException // The resource cannot be found. // @@ -268,6 +271,9 @@ func (c *LicenseManager) CheckoutBorrowLicenseRequest(input *CheckoutBorrowLicen // * ValidationException // The provided input is not valid. Try your request again. // +// * InvalidParameterValueException +// One or more parameter values are not valid. +// // * ResourceNotFoundException // The resource cannot be found. // @@ -376,6 +382,9 @@ func (c *LicenseManager) CheckoutLicenseRequest(input *CheckoutLicenseInput) (re // * ValidationException // The provided input is not valid. Try your request again. // +// * InvalidParameterValueException +// One or more parameter values are not valid. +// // * ResourceNotFoundException // The resource cannot be found. // @@ -5473,6 +5482,8 @@ type CreateGrantVersionInput struct { // Grant status. Status *string `type:"string" enum:"GrantStatus"` + + StatusReason *string `type:"string"` } // String returns the string representation @@ -5540,6 +5551,12 @@ func (s *CreateGrantVersionInput) SetStatus(v string) *CreateGrantVersionInput { return s } +// SetStatusReason sets the StatusReason field's value. +func (s *CreateGrantVersionInput) SetStatusReason(v string) *CreateGrantVersionInput { + s.StatusReason = &v + return s +} + type CreateGrantVersionOutput struct { _ struct{} `type:"structure"` @@ -6575,6 +6592,8 @@ type DeleteGrantInput struct { // GrantArn is a required field GrantArn *string `type:"string" required:"true"` + StatusReason *string `type:"string"` + // Current version of the grant. // // Version is a required field @@ -6613,6 +6632,12 @@ func (s *DeleteGrantInput) SetGrantArn(v string) *DeleteGrantInput { return s } +// SetStatusReason sets the StatusReason field's value. +func (s *DeleteGrantInput) SetStatusReason(v string) *DeleteGrantInput { + s.StatusReason = &v + return s +} + // SetVersion sets the Version field's value. func (s *DeleteGrantInput) SetVersion(v string) *DeleteGrantInput { s.Version = &v @@ -10968,6 +10993,8 @@ type ReceivedMetadata struct { // Received status. ReceivedStatus *string `type:"string" enum:"ReceivedStatus"` + + ReceivedStatusReason *string `type:"string"` } // String returns the string representation @@ -10992,6 +11019,12 @@ func (s *ReceivedMetadata) SetReceivedStatus(v string) *ReceivedMetadata { return s } +// SetReceivedStatusReason sets the ReceivedStatusReason field's value. +func (s *ReceivedMetadata) SetReceivedStatusReason(v string) *ReceivedMetadata { + s.ReceivedStatusReason = &v + return s +} + // This is not the correct Region for the resource. Try again. type RedirectException struct { _ struct{} `type:"structure"` @@ -12733,6 +12766,9 @@ const ( // GrantStatusDisabled is a GrantStatus enum value GrantStatusDisabled = "DISABLED" + + // GrantStatusWorkflowCompleted is a GrantStatus enum value + GrantStatusWorkflowCompleted = "WORKFLOW_COMPLETED" ) // GrantStatus_Values returns all elements of the GrantStatus enum @@ -12746,6 +12782,7 @@ func GrantStatus_Values() []string { GrantStatusDeleted, GrantStatusPendingDelete, GrantStatusDisabled, + GrantStatusWorkflowCompleted, } } @@ -12886,6 +12923,9 @@ const ( // ReceivedStatusDisabled is a ReceivedStatus enum value ReceivedStatusDisabled = "DISABLED" + + // ReceivedStatusWorkflowCompleted is a ReceivedStatus enum value + ReceivedStatusWorkflowCompleted = "WORKFLOW_COMPLETED" ) // ReceivedStatus_Values returns all elements of the ReceivedStatus enum @@ -12898,6 +12938,7 @@ func ReceivedStatus_Values() []string { ReceivedStatusFailedWorkflow, ReceivedStatusDeleted, ReceivedStatusDisabled, + ReceivedStatusWorkflowCompleted, } } diff --git a/service/mediatailor/api.go b/service/mediatailor/api.go index 1000a977e68..c5f97d70d2d 100644 --- a/service/mediatailor/api.go +++ b/service/mediatailor/api.go @@ -6559,6 +6559,58 @@ func (s *ResponseOutputItem) SetSourceGroup(v string) *ResponseOutputItem { return s } +// The schedule's ad break properties. +type ScheduleAdBreak struct { + _ struct{} `type:"structure"` + + // The approximate duration of the ad break, in seconds. + ApproximateDurationSeconds *int64 `type:"long"` + + // The approximate time that the ad will start playing. + ApproximateStartTime *time.Time `type:"timestamp" timestampFormat:"unixTimestamp"` + + // The name of the source location containing the VOD source used for the ad + // break. + SourceLocationName *string `type:"string"` + + // The name of the VOD source used for the ad break. + VodSourceName *string `type:"string"` +} + +// String returns the string representation +func (s ScheduleAdBreak) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ScheduleAdBreak) GoString() string { + return s.String() +} + +// SetApproximateDurationSeconds sets the ApproximateDurationSeconds field's value. +func (s *ScheduleAdBreak) SetApproximateDurationSeconds(v int64) *ScheduleAdBreak { + s.ApproximateDurationSeconds = &v + return s +} + +// SetApproximateStartTime sets the ApproximateStartTime field's value. +func (s *ScheduleAdBreak) SetApproximateStartTime(v time.Time) *ScheduleAdBreak { + s.ApproximateStartTime = &v + return s +} + +// SetSourceLocationName sets the SourceLocationName field's value. +func (s *ScheduleAdBreak) SetSourceLocationName(v string) *ScheduleAdBreak { + s.SourceLocationName = &v + return s +} + +// SetVodSourceName sets the VodSourceName field's value. +func (s *ScheduleAdBreak) SetVodSourceName(v string) *ScheduleAdBreak { + s.VodSourceName = &v + return s +} + // Schedule configuration parameters. A channel must be stopped before changes // can be made to the schedule. type ScheduleConfiguration struct { @@ -6629,6 +6681,9 @@ type ScheduleEntry struct { // ProgramName is a required field ProgramName *string `type:"string" required:"true"` + // The schedule's ad break properties. + ScheduleAdBreaks []*ScheduleAdBreak `type:"list"` + // The name of the source location. // // SourceLocationName is a required field @@ -6680,6 +6735,12 @@ func (s *ScheduleEntry) SetProgramName(v string) *ScheduleEntry { return s } +// SetScheduleAdBreaks sets the ScheduleAdBreaks field's value. +func (s *ScheduleEntry) SetScheduleAdBreaks(v []*ScheduleAdBreak) *ScheduleEntry { + s.ScheduleAdBreaks = v + return s +} + // SetSourceLocationName sets the SourceLocationName field's value. func (s *ScheduleEntry) SetSourceLocationName(v string) *ScheduleEntry { s.SourceLocationName = &v diff --git a/service/quicksight/api.go b/service/quicksight/api.go index 74ee11b010b..4981c7f0a6b 100644 --- a/service/quicksight/api.go +++ b/service/quicksight/api.go @@ -650,6 +650,223 @@ func (c *QuickSight) CreateDataSourceWithContext(ctx aws.Context, input *CreateD return out, req.Send() } +const opCreateFolder = "CreateFolder" + +// CreateFolderRequest generates a "aws/request.Request" representing the +// client's request for the CreateFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateFolder for more information on using the CreateFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateFolderRequest method. +// req, resp := client.CreateFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolder +func (c *QuickSight) CreateFolderRequest(input *CreateFolderInput) (req *request.Request, output *CreateFolderOutput) { + op := &request.Operation{ + Name: opCreateFolder, + HTTPMethod: "POST", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}", + } + + if input == nil { + input = &CreateFolderInput{} + } + + output = &CreateFolderOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateFolder API operation for Amazon QuickSight. +// +// Creates an empty shared folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation CreateFolder for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ThrottlingException +// Access is throttled. +// +// * ResourceExistsException +// The resource specified already exists. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * LimitExceededException +// A limit is exceeded. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolder +func (c *QuickSight) CreateFolder(input *CreateFolderInput) (*CreateFolderOutput, error) { + req, out := c.CreateFolderRequest(input) + return out, req.Send() +} + +// CreateFolderWithContext is the same as CreateFolder with the addition of +// the ability to pass a context and additional request options. +// +// See CreateFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) CreateFolderWithContext(ctx aws.Context, input *CreateFolderInput, opts ...request.Option) (*CreateFolderOutput, error) { + req, out := c.CreateFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateFolderMembership = "CreateFolderMembership" + +// CreateFolderMembershipRequest generates a "aws/request.Request" representing the +// client's request for the CreateFolderMembership operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateFolderMembership for more information on using the CreateFolderMembership +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateFolderMembershipRequest method. +// req, resp := client.CreateFolderMembershipRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembership +func (c *QuickSight) CreateFolderMembershipRequest(input *CreateFolderMembershipInput) (req *request.Request, output *CreateFolderMembershipOutput) { + op := &request.Operation{ + Name: opCreateFolderMembership, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + } + + if input == nil { + input = &CreateFolderMembershipInput{} + } + + output = &CreateFolderMembershipOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateFolderMembership API operation for Amazon QuickSight. +// +// Adds an asset, such as a dashboard, analysis, or dataset into a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation CreateFolderMembership for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ResourceExistsException +// The resource specified already exists. +// +// * ThrottlingException +// Access is throttled. +// +// * LimitExceededException +// A limit is exceeded. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembership +func (c *QuickSight) CreateFolderMembership(input *CreateFolderMembershipInput) (*CreateFolderMembershipOutput, error) { + req, out := c.CreateFolderMembershipRequest(input) + return out, req.Send() +} + +// CreateFolderMembershipWithContext is the same as CreateFolderMembership with the addition of +// the ability to pass a context and additional request options. +// +// See CreateFolderMembership for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) CreateFolderMembershipWithContext(ctx aws.Context, input *CreateFolderMembershipInput, opts ...request.Option) (*CreateFolderMembershipOutput, error) { + req, out := c.CreateFolderMembershipRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateGroup = "CreateGroup" // CreateGroupRequest generates a "aws/request.Request" representing the @@ -2128,58 +2345,165 @@ func (c *QuickSight) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteD return out, req.Send() } -const opDeleteGroup = "DeleteGroup" +const opDeleteFolder = "DeleteFolder" -// DeleteGroupRequest generates a "aws/request.Request" representing the -// client's request for the DeleteGroup operation. The "output" return +// DeleteFolderRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFolder operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DeleteGroup for more information on using the DeleteGroup +// See DeleteFolder for more information on using the DeleteFolder // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the DeleteGroupRequest method. -// req, resp := client.DeleteGroupRequest(params) +// // Example sending a request using the DeleteFolderRequest method. +// req, resp := client.DeleteFolderRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup -func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolder +func (c *QuickSight) DeleteFolderRequest(input *DeleteFolderInput) (req *request.Request, output *DeleteFolderOutput) { op := &request.Operation{ - Name: opDeleteGroup, + Name: opDeleteFolder, HTTPMethod: "DELETE", - HTTPPath: "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}", } if input == nil { - input = &DeleteGroupInput{} + input = &DeleteFolderInput{} } - output = &DeleteGroupOutput{} + output = &DeleteFolderOutput{} req = c.newRequest(op, input, output) return } -// DeleteGroup API operation for Amazon QuickSight. +// DeleteFolder API operation for Amazon QuickSight. // -// Removes a user group from Amazon QuickSight. +// Deletes an empty folder. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation DeleteGroup for usage and error information. +// API operation DeleteFolder for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * PreconditionNotMetException +// One or more preconditions aren't met. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolder +func (c *QuickSight) DeleteFolder(input *DeleteFolderInput) (*DeleteFolderOutput, error) { + req, out := c.DeleteFolderRequest(input) + return out, req.Send() +} + +// DeleteFolderWithContext is the same as DeleteFolder with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DeleteFolderWithContext(ctx aws.Context, input *DeleteFolderInput, opts ...request.Option) (*DeleteFolderOutput, error) { + req, out := c.DeleteFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteFolderMembership = "DeleteFolderMembership" + +// DeleteFolderMembershipRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFolderMembership operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteFolderMembership for more information on using the DeleteFolderMembership +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteFolderMembershipRequest method. +// req, resp := client.DeleteFolderMembershipRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembership +func (c *QuickSight) DeleteFolderMembershipRequest(input *DeleteFolderMembershipInput) (req *request.Request, output *DeleteFolderMembershipOutput) { + op := &request.Operation{ + Name: opDeleteFolderMembership, + HTTPMethod: "DELETE", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + } + + if input == nil { + input = &DeleteFolderMembershipInput{} + } + + output = &DeleteFolderMembershipOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteFolderMembership API operation for Amazon QuickSight. +// +// Removes an asset, such as a dashboard, analysis, or dataset, from a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DeleteFolderMembership for usage and error information. // // Returned Error Types: // * AccessDeniedException @@ -2198,90 +2522,191 @@ func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) (req *request.R // * ThrottlingException // Access is throttled. // -// * PreconditionNotMetException -// One or more preconditions aren't met. +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. // // * InternalFailureException // An internal failure occurred. // -// * ResourceUnavailableException -// This resource is currently unavailable. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup -func (c *QuickSight) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error) { - req, out := c.DeleteGroupRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembership +func (c *QuickSight) DeleteFolderMembership(input *DeleteFolderMembershipInput) (*DeleteFolderMembershipOutput, error) { + req, out := c.DeleteFolderMembershipRequest(input) return out, req.Send() } -// DeleteGroupWithContext is the same as DeleteGroup with the addition of +// DeleteFolderMembershipWithContext is the same as DeleteFolderMembership with the addition of // the ability to pass a context and additional request options. // -// See DeleteGroup for details on how to use this API operation. +// See DeleteFolderMembership for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *QuickSight) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error) { - req, out := c.DeleteGroupRequest(input) +func (c *QuickSight) DeleteFolderMembershipWithContext(ctx aws.Context, input *DeleteFolderMembershipInput, opts ...request.Option) (*DeleteFolderMembershipOutput, error) { + req, out := c.DeleteFolderMembershipRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeleteGroupMembership = "DeleteGroupMembership" +const opDeleteGroup = "DeleteGroup" -// DeleteGroupMembershipRequest generates a "aws/request.Request" representing the -// client's request for the DeleteGroupMembership operation. The "output" return +// DeleteGroupRequest generates a "aws/request.Request" representing the +// client's request for the DeleteGroup operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DeleteGroupMembership for more information on using the DeleteGroupMembership +// See DeleteGroup for more information on using the DeleteGroup // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the DeleteGroupMembershipRequest method. -// req, resp := client.DeleteGroupMembershipRequest(params) +// // Example sending a request using the DeleteGroupRequest method. +// req, resp := client.DeleteGroupRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership -func (c *QuickSight) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) (req *request.Request, output *DeleteGroupMembershipOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup +func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput) { op := &request.Operation{ - Name: opDeleteGroupMembership, + Name: opDeleteGroup, HTTPMethod: "DELETE", - HTTPPath: "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + HTTPPath: "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", } if input == nil { - input = &DeleteGroupMembershipInput{} + input = &DeleteGroupInput{} } - output = &DeleteGroupMembershipOutput{} + output = &DeleteGroupOutput{} req = c.newRequest(op, input, output) return } -// DeleteGroupMembership API operation for Amazon QuickSight. +// DeleteGroup API operation for Amazon QuickSight. // -// Removes a user from a group so that the user is no longer a member of the -// group. +// Removes a user group from Amazon QuickSight. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation DeleteGroupMembership for usage and error information. +// API operation DeleteGroup for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * PreconditionNotMetException +// One or more preconditions aren't met. +// +// * InternalFailureException +// An internal failure occurred. +// +// * ResourceUnavailableException +// This resource is currently unavailable. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup +func (c *QuickSight) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error) { + req, out := c.DeleteGroupRequest(input) + return out, req.Send() +} + +// DeleteGroupWithContext is the same as DeleteGroup with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteGroup for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error) { + req, out := c.DeleteGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteGroupMembership = "DeleteGroupMembership" + +// DeleteGroupMembershipRequest generates a "aws/request.Request" representing the +// client's request for the DeleteGroupMembership operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteGroupMembership for more information on using the DeleteGroupMembership +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteGroupMembershipRequest method. +// req, resp := client.DeleteGroupMembershipRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership +func (c *QuickSight) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) (req *request.Request, output *DeleteGroupMembershipOutput) { + op := &request.Operation{ + Name: opDeleteGroupMembership, + HTTPMethod: "DELETE", + HTTPPath: "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + } + + if input == nil { + input = &DeleteGroupMembershipInput{} + } + + output = &DeleteGroupMembershipOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteGroupMembership API operation for Amazon QuickSight. +// +// Removes a user from a group so that the user is no longer a member of the +// group. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DeleteGroupMembership for usage and error information. // // Returned Error Types: // * AccessDeniedException @@ -4148,6 +4573,310 @@ func (c *QuickSight) DescribeDataSourcePermissionsWithContext(ctx aws.Context, i return out, req.Send() } +const opDescribeFolder = "DescribeFolder" + +// DescribeFolderRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeFolder for more information on using the DescribeFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeFolderRequest method. +// req, resp := client.DescribeFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolder +func (c *QuickSight) DescribeFolderRequest(input *DescribeFolderInput) (req *request.Request, output *DescribeFolderOutput) { + op := &request.Operation{ + Name: opDescribeFolder, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}", + } + + if input == nil { + input = &DescribeFolderInput{} + } + + output = &DescribeFolderOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeFolder API operation for Amazon QuickSight. +// +// Describes a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DescribeFolder for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolder +func (c *QuickSight) DescribeFolder(input *DescribeFolderInput) (*DescribeFolderOutput, error) { + req, out := c.DescribeFolderRequest(input) + return out, req.Send() +} + +// DescribeFolderWithContext is the same as DescribeFolder with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DescribeFolderWithContext(ctx aws.Context, input *DescribeFolderInput, opts ...request.Option) (*DescribeFolderOutput, error) { + req, out := c.DescribeFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeFolderPermissions = "DescribeFolderPermissions" + +// DescribeFolderPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFolderPermissions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeFolderPermissions for more information on using the DescribeFolderPermissions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeFolderPermissionsRequest method. +// req, resp := client.DescribeFolderPermissionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissions +func (c *QuickSight) DescribeFolderPermissionsRequest(input *DescribeFolderPermissionsInput) (req *request.Request, output *DescribeFolderPermissionsOutput) { + op := &request.Operation{ + Name: opDescribeFolderPermissions, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + } + + if input == nil { + input = &DescribeFolderPermissionsInput{} + } + + output = &DescribeFolderPermissionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeFolderPermissions API operation for Amazon QuickSight. +// +// Describes permissions for a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DescribeFolderPermissions for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissions +func (c *QuickSight) DescribeFolderPermissions(input *DescribeFolderPermissionsInput) (*DescribeFolderPermissionsOutput, error) { + req, out := c.DescribeFolderPermissionsRequest(input) + return out, req.Send() +} + +// DescribeFolderPermissionsWithContext is the same as DescribeFolderPermissions with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeFolderPermissions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DescribeFolderPermissionsWithContext(ctx aws.Context, input *DescribeFolderPermissionsInput, opts ...request.Option) (*DescribeFolderPermissionsOutput, error) { + req, out := c.DescribeFolderPermissionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeFolderResolvedPermissions = "DescribeFolderResolvedPermissions" + +// DescribeFolderResolvedPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFolderResolvedPermissions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeFolderResolvedPermissions for more information on using the DescribeFolderResolvedPermissions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeFolderResolvedPermissionsRequest method. +// req, resp := client.DescribeFolderResolvedPermissionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissions +func (c *QuickSight) DescribeFolderResolvedPermissionsRequest(input *DescribeFolderResolvedPermissionsInput) (req *request.Request, output *DescribeFolderResolvedPermissionsOutput) { + op := &request.Operation{ + Name: opDescribeFolderResolvedPermissions, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", + } + + if input == nil { + input = &DescribeFolderResolvedPermissionsInput{} + } + + output = &DescribeFolderResolvedPermissionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeFolderResolvedPermissions API operation for Amazon QuickSight. +// +// Describes the folder resolved permissions. Permissions consists of both folder +// direct permissions and the inherited permissions from the ancestor folders. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation DescribeFolderResolvedPermissions for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissions +func (c *QuickSight) DescribeFolderResolvedPermissions(input *DescribeFolderResolvedPermissionsInput) (*DescribeFolderResolvedPermissionsOutput, error) { + req, out := c.DescribeFolderResolvedPermissionsRequest(input) + return out, req.Send() +} + +// DescribeFolderResolvedPermissionsWithContext is the same as DescribeFolderResolvedPermissions with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeFolderResolvedPermissions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) DescribeFolderResolvedPermissionsWithContext(ctx aws.Context, input *DescribeFolderResolvedPermissionsInput, opts ...request.Option) (*DescribeFolderResolvedPermissionsOutput, error) { + req, out := c.DescribeFolderResolvedPermissionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeGroup = "DescribeGroup" // DescribeGroupRequest generates a "aws/request.Request" representing the @@ -6280,6 +7009,214 @@ func (c *QuickSight) ListDataSourcesPagesWithContext(ctx aws.Context, input *Lis return p.Err() } +const opListFolderMembers = "ListFolderMembers" + +// ListFolderMembersRequest generates a "aws/request.Request" representing the +// client's request for the ListFolderMembers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListFolderMembers for more information on using the ListFolderMembers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListFolderMembersRequest method. +// req, resp := client.ListFolderMembersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembers +func (c *QuickSight) ListFolderMembersRequest(input *ListFolderMembersInput) (req *request.Request, output *ListFolderMembersOutput) { + op := &request.Operation{ + Name: opListFolderMembers, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/members", + } + + if input == nil { + input = &ListFolderMembersInput{} + } + + output = &ListFolderMembersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListFolderMembers API operation for Amazon QuickSight. +// +// List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation ListFolderMembers for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembers +func (c *QuickSight) ListFolderMembers(input *ListFolderMembersInput) (*ListFolderMembersOutput, error) { + req, out := c.ListFolderMembersRequest(input) + return out, req.Send() +} + +// ListFolderMembersWithContext is the same as ListFolderMembers with the addition of +// the ability to pass a context and additional request options. +// +// See ListFolderMembers for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) ListFolderMembersWithContext(ctx aws.Context, input *ListFolderMembersInput, opts ...request.Option) (*ListFolderMembersOutput, error) { + req, out := c.ListFolderMembersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListFolders = "ListFolders" + +// ListFoldersRequest generates a "aws/request.Request" representing the +// client's request for the ListFolders operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListFolders for more information on using the ListFolders +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListFoldersRequest method. +// req, resp := client.ListFoldersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolders +func (c *QuickSight) ListFoldersRequest(input *ListFoldersInput) (req *request.Request, output *ListFoldersOutput) { + op := &request.Operation{ + Name: opListFolders, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/folders", + } + + if input == nil { + input = &ListFoldersInput{} + } + + output = &ListFoldersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListFolders API operation for Amazon QuickSight. +// +// Lists all folders in an account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation ListFolders for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolders +func (c *QuickSight) ListFolders(input *ListFoldersInput) (*ListFoldersOutput, error) { + req, out := c.ListFoldersRequest(input) + return out, req.Send() +} + +// ListFoldersWithContext is the same as ListFolders with the addition of +// the ability to pass a context and additional request options. +// +// See ListFolders for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) ListFoldersWithContext(ctx aws.Context, input *ListFoldersInput, opts ...request.Option) (*ListFoldersOutput, error) { + req, out := c.ListFoldersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListGroupMemberships = "ListGroupMemberships" // ListGroupMembershipsRequest generates a "aws/request.Request" representing the @@ -8715,84 +9652,62 @@ func (c *QuickSight) SearchDashboardsPagesWithContext(ctx aws.Context, input *Se return p.Err() } -const opTagResource = "TagResource" +const opSearchFolders = "SearchFolders" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// SearchFoldersRequest generates a "aws/request.Request" representing the +// client's request for the SearchFolders operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TagResource for more information on using the TagResource +// See SearchFolders for more information on using the SearchFolders // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the SearchFoldersRequest method. +// req, resp := client.SearchFoldersRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource -func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFolders +func (c *QuickSight) SearchFoldersRequest(input *SearchFoldersInput) (req *request.Request, output *SearchFoldersOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opSearchFolders, HTTPMethod: "POST", - HTTPPath: "/resources/{ResourceArn}/tags", + HTTPPath: "/accounts/{AwsAccountId}/search/folders", } if input == nil { - input = &TagResourceInput{} + input = &SearchFoldersInput{} } - output = &TagResourceOutput{} + output = &SearchFoldersOutput{} req = c.newRequest(op, input, output) return } -// TagResource API operation for Amazon QuickSight. -// -// Assigns one or more tags (key-value pairs) to the specified QuickSight resource. -// -// Tags can help you organize and categorize your resources. You can also use -// them to scope user permissions, by granting a user permission to access or -// change only resources with certain tag values. You can use the TagResource -// operation with a resource that already has tags. If you specify a new tag -// key for the resource, this tag is appended to the list of tags associated -// with the resource. If you specify a tag key that is already associated with -// the resource, the new tag value that you specify replaces the previous value -// for that tag. -// -// You can associate as many as 50 tags with a resource. QuickSight supports -// tagging on data set, data source, dashboard, and template. +// SearchFolders API operation for Amazon QuickSight. // -// Tagging for QuickSight works in a similar way to tagging for other AWS services, -// except for the following: -// -// * You can't use tags to track AWS costs for QuickSight. This restriction -// is because QuickSight costs are based on users and SPICE capacity, which -// aren't taggable resources. -// -// * QuickSight doesn't currently support the Tag Editor for AWS Resource -// Groups. +// Searches the subfolders in a folder. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation TagResource for usage and error information. +// API operation SearchFolders for usage and error information. // // Returned Error Types: -// * LimitExceededException -// A limit is exceeded. +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. // // * AccessDeniedException // You don't have access to this item. The provided credentials couldn't be @@ -8801,94 +9716,125 @@ func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.R // your policies have the correct permissions, and that you are using the correct // access keys. // -// * InvalidParameterValueException -// One or more parameters has a value that isn't valid. -// // * ResourceNotFoundException // One or more resources can't be found. // // * ThrottlingException // Access is throttled. // +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource -func (c *QuickSight) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFolders +func (c *QuickSight) SearchFolders(input *SearchFoldersInput) (*SearchFoldersOutput, error) { + req, out := c.SearchFoldersRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// SearchFoldersWithContext is the same as SearchFolders with the addition of // the ability to pass a context and additional request options. // -// See TagResource for details on how to use this API operation. +// See SearchFolders for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *QuickSight) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *QuickSight) SearchFoldersWithContext(ctx aws.Context, input *SearchFoldersInput, opts ...request.Option) (*SearchFoldersOutput, error) { + req, out := c.SearchFoldersRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +const opTagResource = "TagResource" -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UntagResource for more information on using the UntagResource +// See TagResource for more information on using the TagResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource -func (c *QuickSight) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource +func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { op := &request.Operation{ - Name: opUntagResource, - HTTPMethod: "DELETE", + Name: opTagResource, + HTTPMethod: "POST", HTTPPath: "/resources/{ResourceArn}/tags", } if input == nil { - input = &UntagResourceInput{} + input = &TagResourceInput{} } - output = &UntagResourceOutput{} + output = &TagResourceOutput{} req = c.newRequest(op, input, output) return } -// UntagResource API operation for Amazon QuickSight. +// TagResource API operation for Amazon QuickSight. // -// Removes a tag or tags from a resource. +// Assigns one or more tags (key-value pairs) to the specified QuickSight resource. +// +// Tags can help you organize and categorize your resources. You can also use +// them to scope user permissions, by granting a user permission to access or +// change only resources with certain tag values. You can use the TagResource +// operation with a resource that already has tags. If you specify a new tag +// key for the resource, this tag is appended to the list of tags associated +// with the resource. If you specify a tag key that is already associated with +// the resource, the new tag value that you specify replaces the previous value +// for that tag. +// +// You can associate as many as 50 tags with a resource. QuickSight supports +// tagging on data set, data source, dashboard, and template. +// +// Tagging for QuickSight works in a similar way to tagging for other AWS services, +// except for the following: +// +// * You can't use tags to track AWS costs for QuickSight. This restriction +// is because QuickSight costs are based on users and SPICE capacity, which +// aren't taggable resources. +// +// * QuickSight doesn't currently support the Tag Editor for AWS Resource +// Groups. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation UntagResource for usage and error information. +// API operation TagResource for usage and error information. // // Returned Error Types: +// * LimitExceededException +// A limit is exceeded. +// // * AccessDeniedException // You don't have access to this item. The provided credentials couldn't be // validated. You might not be authorized to carry out the request. Make sure @@ -8908,86 +9854,181 @@ func (c *QuickSight) UntagResourceRequest(input *UntagResourceInput) (req *reque // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource -func (c *QuickSight) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource +func (c *QuickSight) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) return out, req.Send() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// TagResourceWithContext is the same as TagResource with the addition of // the ability to pass a context and additional request options. // -// See UntagResource for details on how to use this API operation. +// See TagResource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *QuickSight) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *QuickSight) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAccountCustomization = "UpdateAccountCustomization" +const opUntagResource = "UntagResource" -// UpdateAccountCustomizationRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAccountCustomization operation. The "output" return +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAccountCustomization for more information on using the UpdateAccountCustomization +// See UntagResource for more information on using the UntagResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAccountCustomizationRequest method. -// req, resp := client.UpdateAccountCustomizationRequest(params) +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization -func (c *QuickSight) UpdateAccountCustomizationRequest(input *UpdateAccountCustomizationInput) (req *request.Request, output *UpdateAccountCustomizationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource +func (c *QuickSight) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { op := &request.Operation{ - Name: opUpdateAccountCustomization, - HTTPMethod: "PUT", - HTTPPath: "/accounts/{AwsAccountId}/customizations", + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/resources/{ResourceArn}/tags", } if input == nil { - input = &UpdateAccountCustomizationInput{} + input = &UntagResourceInput{} } - output = &UpdateAccountCustomizationOutput{} + output = &UntagResourceOutput{} req = c.newRequest(op, input, output) return } -// UpdateAccountCustomization API operation for Amazon QuickSight. -// -// Updates Amazon QuickSight customizations the current AWS Region. Currently, -// the only customization you can use is a theme. +// UntagResource API operation for Amazon QuickSight. // -// You can use customizations for your AWS account or, if you specify a namespace, -// for a QuickSight namespace instead. Customizations that apply to a namespace -// override customizations that apply to an AWS account. To find out which customizations -// apply, use the DescribeAccountCustomization API operation. +// Removes a tag or tags from a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation UpdateAccountCustomization for usage and error information. +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource +func (c *QuickSight) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAccountCustomization = "UpdateAccountCustomization" + +// UpdateAccountCustomizationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAccountCustomization operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAccountCustomization for more information on using the UpdateAccountCustomization +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAccountCustomizationRequest method. +// req, resp := client.UpdateAccountCustomizationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization +func (c *QuickSight) UpdateAccountCustomizationRequest(input *UpdateAccountCustomizationInput) (req *request.Request, output *UpdateAccountCustomizationOutput) { + op := &request.Operation{ + Name: opUpdateAccountCustomization, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/customizations", + } + + if input == nil { + input = &UpdateAccountCustomizationInput{} + } + + output = &UpdateAccountCustomizationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAccountCustomization API operation for Amazon QuickSight. +// +// Updates Amazon QuickSight customizations the current AWS Region. Currently, +// the only customization you can use is a theme. +// +// You can use customizations for your AWS account or, if you specify a namespace, +// for a QuickSight namespace instead. Customizations that apply to a namespace +// override customizations that apply to an AWS account. To find out which customizations +// apply, use the DescribeAccountCustomization API operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation UpdateAccountCustomization for usage and error information. // // Returned Error Types: // * AccessDeniedException @@ -10026,6 +11067,217 @@ func (c *QuickSight) UpdateDataSourcePermissionsWithContext(ctx aws.Context, inp return out, req.Send() } +const opUpdateFolder = "UpdateFolder" + +// UpdateFolderRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateFolder for more information on using the UpdateFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateFolderRequest method. +// req, resp := client.UpdateFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolder +func (c *QuickSight) UpdateFolderRequest(input *UpdateFolderInput) (req *request.Request, output *UpdateFolderOutput) { + op := &request.Operation{ + Name: opUpdateFolder, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}", + } + + if input == nil { + input = &UpdateFolderInput{} + } + + output = &UpdateFolderOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateFolder API operation for Amazon QuickSight. +// +// Updates the name of a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation UpdateFolder for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * ResourceExistsException +// The resource specified already exists. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolder +func (c *QuickSight) UpdateFolder(input *UpdateFolderInput) (*UpdateFolderOutput, error) { + req, out := c.UpdateFolderRequest(input) + return out, req.Send() +} + +// UpdateFolderWithContext is the same as UpdateFolder with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) UpdateFolderWithContext(ctx aws.Context, input *UpdateFolderInput, opts ...request.Option) (*UpdateFolderOutput, error) { + req, out := c.UpdateFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateFolderPermissions = "UpdateFolderPermissions" + +// UpdateFolderPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFolderPermissions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateFolderPermissions for more information on using the UpdateFolderPermissions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateFolderPermissionsRequest method. +// req, resp := client.UpdateFolderPermissionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissions +func (c *QuickSight) UpdateFolderPermissionsRequest(input *UpdateFolderPermissionsInput) (req *request.Request, output *UpdateFolderPermissionsOutput) { + op := &request.Operation{ + Name: opUpdateFolderPermissions, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + } + + if input == nil { + input = &UpdateFolderPermissionsInput{} + } + + output = &UpdateFolderPermissionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateFolderPermissions API operation for Amazon QuickSight. +// +// Updates permissions of a folder. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation UpdateFolderPermissions for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * LimitExceededException +// A limit is exceeded. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissions +func (c *QuickSight) UpdateFolderPermissions(input *UpdateFolderPermissionsInput) (*UpdateFolderPermissionsOutput, error) { + req, out := c.UpdateFolderPermissionsRequest(input) + return out, req.Send() +} + +// UpdateFolderPermissionsWithContext is the same as UpdateFolderPermissions with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFolderPermissions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *QuickSight) UpdateFolderPermissionsWithContext(ctx aws.Context, input *UpdateFolderPermissionsInput, opts ...request.Option) (*UpdateFolderPermissionsOutput, error) { + req, out := c.UpdateFolderPermissionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateGroup = "UpdateGroup" // UpdateGroupRequest generates a "aws/request.Request" representing the @@ -13748,6 +15000,328 @@ func (s *CreateDataSourceOutput) SetStatus(v int64) *CreateDataSourceOutput { return s } +type CreateFolderInput struct { + _ struct{} `type:"structure"` + + // The AWS Account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The type of folder. By default, folderType is SHARED. + FolderType *string `type:"string" enum:"FolderType"` + + // The name of the folder. + Name *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) for the parent folder. + // + // ParentFolderArn can be null. An empty parentFolderArn creates a root-level + // folder. + ParentFolderArn *string `type:"string"` + + // A structure that describes the principals and the resource-level permissions + // of a folder. + // + // To specify no permissions, omit Permissions. + Permissions []*ResourcePermission `min:"1" type:"list"` + + // Tags for the folder. + Tags []*Tag `min:"1" type:"list"` +} + +// String returns the string representation +func (s CreateFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFolderInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Permissions != nil && len(s.Permissions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Permissions", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Permissions != nil { + for i, v := range s.Permissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Permissions", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *CreateFolderInput) SetAwsAccountId(v string) *CreateFolderInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *CreateFolderInput) SetFolderId(v string) *CreateFolderInput { + s.FolderId = &v + return s +} + +// SetFolderType sets the FolderType field's value. +func (s *CreateFolderInput) SetFolderType(v string) *CreateFolderInput { + s.FolderType = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateFolderInput) SetName(v string) *CreateFolderInput { + s.Name = &v + return s +} + +// SetParentFolderArn sets the ParentFolderArn field's value. +func (s *CreateFolderInput) SetParentFolderArn(v string) *CreateFolderInput { + s.ParentFolderArn = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *CreateFolderInput) SetPermissions(v []*ResourcePermission) *CreateFolderInput { + s.Permissions = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateFolderInput) SetTags(v []*Tag) *CreateFolderInput { + s.Tags = v + return s +} + +type CreateFolderMembershipInput struct { + _ struct{} `type:"structure"` + + // The AWS Account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The ID of the asset (the dashboard, analysis, or dataset). + // + // MemberId is a required field + MemberId *string `location:"uri" locationName:"MemberId" min:"1" type:"string" required:"true"` + + // The type of the member, including DASHBOARD, ANALYSIS, and DATASET. + // + // MemberType is a required field + MemberType *string `location:"uri" locationName:"MemberType" type:"string" required:"true" enum:"MemberType"` +} + +// String returns the string representation +func (s CreateFolderMembershipInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFolderMembershipInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFolderMembershipInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFolderMembershipInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.MemberId == nil { + invalidParams.Add(request.NewErrParamRequired("MemberId")) + } + if s.MemberId != nil && len(*s.MemberId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) + } + if s.MemberType == nil { + invalidParams.Add(request.NewErrParamRequired("MemberType")) + } + if s.MemberType != nil && len(*s.MemberType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberType", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *CreateFolderMembershipInput) SetAwsAccountId(v string) *CreateFolderMembershipInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *CreateFolderMembershipInput) SetFolderId(v string) *CreateFolderMembershipInput { + s.FolderId = &v + return s +} + +// SetMemberId sets the MemberId field's value. +func (s *CreateFolderMembershipInput) SetMemberId(v string) *CreateFolderMembershipInput { + s.MemberId = &v + return s +} + +// SetMemberType sets the MemberType field's value. +func (s *CreateFolderMembershipInput) SetMemberType(v string) *CreateFolderMembershipInput { + s.MemberType = &v + return s +} + +type CreateFolderMembershipOutput struct { + _ struct{} `type:"structure"` + + // Information about the member in the folder. + FolderMember *FolderMember `type:"structure"` + + // The request ID. + RequestId *string `type:"string"` + + // The status of the folder membership. If succeeded, the status is SC_OK (200). + Status *int64 `type:"integer"` +} + +// String returns the string representation +func (s CreateFolderMembershipOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFolderMembershipOutput) GoString() string { + return s.String() +} + +// SetFolderMember sets the FolderMember field's value. +func (s *CreateFolderMembershipOutput) SetFolderMember(v *FolderMember) *CreateFolderMembershipOutput { + s.FolderMember = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *CreateFolderMembershipOutput) SetRequestId(v string) *CreateFolderMembershipOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateFolderMembershipOutput) SetStatus(v int64) *CreateFolderMembershipOutput { + s.Status = &v + return s +} + +type CreateFolderOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the newly created folder. + Arn *string `type:"string"` + + // The folder ID for the newly created folder. + FolderId *string `min:"1" type:"string"` + + // The request ID for the newly created folder. + RequestId *string `type:"string"` + + // The status of the newly created folder. If succeeded, the status is SC_OK + // (200). + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s CreateFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFolderOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateFolderOutput) SetArn(v string) *CreateFolderOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *CreateFolderOutput) SetFolderId(v string) *CreateFolderOutput { + s.FolderId = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *CreateFolderOutput) SetRequestId(v string) *CreateFolderOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateFolderOutput) SetStatus(v int64) *CreateFolderOutput { + s.Status = &v + return s +} + // The request object for this operation. type CreateGroupInput struct { _ struct{} `type:"structure"` @@ -17619,6 +19193,239 @@ func (s *DeleteDataSourceOutput) SetStatus(v int64) *DeleteDataSourceOutput { return s } +type DeleteFolderInput struct { + _ struct{} `type:"structure"` + + // The AWS Account ID for the folder. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFolderInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DeleteFolderInput) SetAwsAccountId(v string) *DeleteFolderInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DeleteFolderInput) SetFolderId(v string) *DeleteFolderInput { + s.FolderId = &v + return s +} + +type DeleteFolderMembershipInput struct { + _ struct{} `type:"structure"` + + // The AWS Account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The Folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The ID of the asset (the dashboard, analysis, or dataset) that you want to + // delete. + // + // MemberId is a required field + MemberId *string `location:"uri" locationName:"MemberId" min:"1" type:"string" required:"true"` + + // The type of the member, including DASHBOARD, ANALYSIS, and DATASET + // + // MemberType is a required field + MemberType *string `location:"uri" locationName:"MemberType" type:"string" required:"true" enum:"MemberType"` +} + +// String returns the string representation +func (s DeleteFolderMembershipInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteFolderMembershipInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFolderMembershipInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFolderMembershipInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.MemberId == nil { + invalidParams.Add(request.NewErrParamRequired("MemberId")) + } + if s.MemberId != nil && len(*s.MemberId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberId", 1)) + } + if s.MemberType == nil { + invalidParams.Add(request.NewErrParamRequired("MemberType")) + } + if s.MemberType != nil && len(*s.MemberType) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MemberType", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DeleteFolderMembershipInput) SetAwsAccountId(v string) *DeleteFolderMembershipInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DeleteFolderMembershipInput) SetFolderId(v string) *DeleteFolderMembershipInput { + s.FolderId = &v + return s +} + +// SetMemberId sets the MemberId field's value. +func (s *DeleteFolderMembershipInput) SetMemberId(v string) *DeleteFolderMembershipInput { + s.MemberId = &v + return s +} + +// SetMemberType sets the MemberType field's value. +func (s *DeleteFolderMembershipInput) SetMemberType(v string) *DeleteFolderMembershipInput { + s.MemberType = &v + return s +} + +type DeleteFolderMembershipOutput struct { + _ struct{} `type:"structure"` + + // The request ID. + RequestId *string `type:"string"` + + // The status of deleting the asset. If succeeded, the status is SC_OK (200). + Status *int64 `type:"integer"` +} + +// String returns the string representation +func (s DeleteFolderMembershipOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteFolderMembershipOutput) GoString() string { + return s.String() +} + +// SetRequestId sets the RequestId field's value. +func (s *DeleteFolderMembershipOutput) SetRequestId(v string) *DeleteFolderMembershipOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DeleteFolderMembershipOutput) SetStatus(v int64) *DeleteFolderMembershipOutput { + s.Status = &v + return s +} + +type DeleteFolderOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name of the deleted folder. + Arn *string `type:"string"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // The request ID. + RequestId *string `type:"string"` + + // The status of deleting the folder. If succeeded, the status is SC_OK (200). + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DeleteFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteFolderOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DeleteFolderOutput) SetArn(v string) *DeleteFolderOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DeleteFolderOutput) SetFolderId(v string) *DeleteFolderOutput { + s.FolderId = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *DeleteFolderOutput) SetRequestId(v string) *DeleteFolderOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DeleteFolderOutput) SetStatus(v int64) *DeleteFolderOutput { + s.Status = &v + return s +} + type DeleteGroupInput struct { _ struct{} `type:"structure"` @@ -19915,6 +21722,339 @@ func (s *DescribeDataSourcePermissionsOutput) SetStatus(v int64) *DescribeDataSo return s } +type DescribeFolderInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFolderInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeFolderInput) SetAwsAccountId(v string) *DescribeFolderInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DescribeFolderInput) SetFolderId(v string) *DescribeFolderInput { + s.FolderId = &v + return s +} + +type DescribeFolderOutput struct { + _ struct{} `type:"structure"` + + // Information about the folder. + Folder *Folder `type:"structure"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK (200). + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DescribeFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderOutput) GoString() string { + return s.String() +} + +// SetFolder sets the Folder field's value. +func (s *DescribeFolderOutput) SetFolder(v *Folder) *DescribeFolderOutput { + s.Folder = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *DescribeFolderOutput) SetRequestId(v string) *DescribeFolderOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeFolderOutput) SetStatus(v int64) *DescribeFolderOutput { + s.Status = &v + return s +} + +type DescribeFolderPermissionsInput struct { + _ struct{} `type:"structure"` + + // The AWS Account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeFolderPermissionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderPermissionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFolderPermissionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFolderPermissionsInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeFolderPermissionsInput) SetAwsAccountId(v string) *DescribeFolderPermissionsInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DescribeFolderPermissionsInput) SetFolderId(v string) *DescribeFolderPermissionsInput { + s.FolderId = &v + return s +} + +type DescribeFolderPermissionsOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the folder. + Arn *string `type:"string"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // Information about the permissions on the folder. + Permissions []*ResourcePermission `min:"1" type:"list"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DescribeFolderPermissionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderPermissionsOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DescribeFolderPermissionsOutput) SetArn(v string) *DescribeFolderPermissionsOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DescribeFolderPermissionsOutput) SetFolderId(v string) *DescribeFolderPermissionsOutput { + s.FolderId = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *DescribeFolderPermissionsOutput) SetPermissions(v []*ResourcePermission) *DescribeFolderPermissionsOutput { + s.Permissions = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *DescribeFolderPermissionsOutput) SetRequestId(v string) *DescribeFolderPermissionsOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeFolderPermissionsOutput) SetStatus(v int64) *DescribeFolderPermissionsOutput { + s.Status = &v + return s +} + +type DescribeFolderResolvedPermissionsInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeFolderResolvedPermissionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderResolvedPermissionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFolderResolvedPermissionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFolderResolvedPermissionsInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeFolderResolvedPermissionsInput) SetAwsAccountId(v string) *DescribeFolderResolvedPermissionsInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DescribeFolderResolvedPermissionsInput) SetFolderId(v string) *DescribeFolderResolvedPermissionsInput { + s.FolderId = &v + return s +} + +type DescribeFolderResolvedPermissionsOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN). + Arn *string `type:"string"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // Information about the permissions on the dashboard. + Permissions []*ResourcePermission `min:"1" type:"list"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DescribeFolderResolvedPermissionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeFolderResolvedPermissionsOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DescribeFolderResolvedPermissionsOutput) SetArn(v string) *DescribeFolderResolvedPermissionsOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *DescribeFolderResolvedPermissionsOutput) SetFolderId(v string) *DescribeFolderResolvedPermissionsOutput { + s.FolderId = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *DescribeFolderResolvedPermissionsOutput) SetPermissions(v []*ResourcePermission) *DescribeFolderResolvedPermissionsOutput { + s.Permissions = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *DescribeFolderResolvedPermissionsOutput) SetRequestId(v string) *DescribeFolderResolvedPermissionsOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeFolderResolvedPermissionsOutput) SetStatus(v int64) *DescribeFolderResolvedPermissionsOutput { + s.Status = &v + return s +} + type DescribeGroupInput struct { _ struct{} `type:"structure"` @@ -21401,6 +23541,231 @@ func (s *FilterOperation) SetConditionExpression(v string) *FilterOperation { return s } +// A folder. +type Folder struct { + _ struct{} `type:"structure"` + + // The folder Amazon Resource Name (ARN). + Arn *string `type:"string"` + + // The time that the folder was created. + CreatedTime *time.Time `type:"timestamp"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // An array of ancestor folder ARN strings. + FolderPath []*string `min:"1" type:"list"` + + // The type of the folder. + FolderType *string `type:"string" enum:"FolderType"` + + // The time that the folder was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // A display name for the folder. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s Folder) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Folder) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Folder) SetArn(v string) *Folder { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *Folder) SetCreatedTime(v time.Time) *Folder { + s.CreatedTime = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *Folder) SetFolderId(v string) *Folder { + s.FolderId = &v + return s +} + +// SetFolderPath sets the FolderPath field's value. +func (s *Folder) SetFolderPath(v []*string) *Folder { + s.FolderPath = v + return s +} + +// SetFolderType sets the FolderType field's value. +func (s *Folder) SetFolderType(v string) *Folder { + s.FolderType = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *Folder) SetLastUpdatedTime(v time.Time) *Folder { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *Folder) SetName(v string) *Folder { + s.Name = &v + return s +} + +// An asset in a folder, such as a dashboard, analysis, or dataset. +type FolderMember struct { + _ struct{} `type:"structure"` + + // The ID of the asset. + MemberId *string `min:"1" type:"string"` + + // The type of the asset. + MemberType *string `type:"string" enum:"MemberType"` +} + +// String returns the string representation +func (s FolderMember) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FolderMember) GoString() string { + return s.String() +} + +// SetMemberId sets the MemberId field's value. +func (s *FolderMember) SetMemberId(v string) *FolderMember { + s.MemberId = &v + return s +} + +// SetMemberType sets the MemberType field's value. +func (s *FolderMember) SetMemberType(v string) *FolderMember { + s.MemberType = &v + return s +} + +// Searches a folder by a filter. +type FolderSearchFilter struct { + _ struct{} `type:"structure"` + + // The name of the value that you want to use as a filter. For example, "Name": + // "PARENT_FOLDER_ARN". + Name *string `type:"string" enum:"FolderFilterAttribute"` + + // The comparison operator that you want to use as a filter. For example, "Operator": + // "StringEquals". + Operator *string `type:"string" enum:"FilterOperator"` + + // The value of the named item (in this example, PARENT_FOLDER_ARN), that you + // want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId". + Value *string `type:"string"` +} + +// String returns the string representation +func (s FolderSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FolderSearchFilter) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *FolderSearchFilter) SetName(v string) *FolderSearchFilter { + s.Name = &v + return s +} + +// SetOperator sets the Operator field's value. +func (s *FolderSearchFilter) SetOperator(v string) *FolderSearchFilter { + s.Operator = &v + return s +} + +// SetValue sets the Value field's value. +func (s *FolderSearchFilter) SetValue(v string) *FolderSearchFilter { + s.Value = &v + return s +} + +// A summary of the folder. +type FolderSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN). + Arn *string `type:"string"` + + // The time that the folder was created. + CreatedTime *time.Time `type:"timestamp"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // The type of folder. + FolderType *string `type:"string" enum:"FolderType"` + + // The time that the folder was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The display name of the folder. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s FolderSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FolderSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *FolderSummary) SetArn(v string) *FolderSummary { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *FolderSummary) SetCreatedTime(v time.Time) *FolderSummary { + s.CreatedTime = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *FolderSummary) SetFolderId(v string) *FolderSummary { + s.FolderId = &v + return s +} + +// SetFolderType sets the FolderType field's value. +func (s *FolderSummary) SetFolderType(v string) *FolderSummary { + s.FolderType = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *FolderSummary) SetLastUpdatedTime(v time.Time) *FolderSummary { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *FolderSummary) SetName(v string) *FolderSummary { + s.Name = &v + return s +} + // Geospatial column group that denotes a hierarchy. type GeoSpatialColumnGroup struct { _ struct{} `type:"structure"` @@ -23331,6 +25696,249 @@ func (s *ListDataSourcesOutput) SetStatus(v int64) *ListDataSourcesOutput { return s } +type ListFolderMembersInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The maximum number of results to be returned per request. + MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `location:"querystring" locationName:"next-token" type:"string"` +} + +// String returns the string representation +func (s ListFolderMembersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListFolderMembersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFolderMembersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFolderMembersInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *ListFolderMembersInput) SetAwsAccountId(v string) *ListFolderMembersInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *ListFolderMembersInput) SetFolderId(v string) *ListFolderMembersInput { + s.FolderId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFolderMembersInput) SetMaxResults(v int64) *ListFolderMembersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFolderMembersInput) SetNextToken(v string) *ListFolderMembersInput { + s.NextToken = &v + return s +} + +type ListFolderMembersOutput struct { + _ struct{} `type:"structure"` + + // A structure that contains all of the folder members (dashboards, analyses, + // and datasets) in the folder. + FolderMemberList []*MemberIdArnPair `type:"list"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `type:"string"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s ListFolderMembersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListFolderMembersOutput) GoString() string { + return s.String() +} + +// SetFolderMemberList sets the FolderMemberList field's value. +func (s *ListFolderMembersOutput) SetFolderMemberList(v []*MemberIdArnPair) *ListFolderMembersOutput { + s.FolderMemberList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFolderMembersOutput) SetNextToken(v string) *ListFolderMembersOutput { + s.NextToken = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *ListFolderMembersOutput) SetRequestId(v string) *ListFolderMembersOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListFolderMembersOutput) SetStatus(v int64) *ListFolderMembersOutput { + s.Status = &v + return s +} + +type ListFoldersInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The maximum number of results to be returned per request. + MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `location:"querystring" locationName:"next-token" type:"string"` +} + +// String returns the string representation +func (s ListFoldersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListFoldersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFoldersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFoldersInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *ListFoldersInput) SetAwsAccountId(v string) *ListFoldersInput { + s.AwsAccountId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFoldersInput) SetMaxResults(v int64) *ListFoldersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFoldersInput) SetNextToken(v string) *ListFoldersInput { + s.NextToken = &v + return s +} + +type ListFoldersOutput struct { + _ struct{} `type:"structure"` + + // A structure that contains all of the folders in your AWS account. This structure + // provides basic information about the folders. + FolderSummaryList []*FolderSummary `type:"list"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `type:"string"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s ListFoldersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListFoldersOutput) GoString() string { + return s.String() +} + +// SetFolderSummaryList sets the FolderSummaryList field's value. +func (s *ListFoldersOutput) SetFolderSummaryList(v []*FolderSummary) *ListFoldersOutput { + s.FolderSummaryList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFoldersOutput) SetNextToken(v string) *ListFoldersOutput { + s.NextToken = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *ListFoldersOutput) SetRequestId(v string) *ListFoldersOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ListFoldersOutput) SetStatus(v int64) *ListFoldersOutput { + s.Status = &v + return s +} + type ListGroupMembershipsInput struct { _ struct{} `type:"structure"` @@ -25550,6 +28158,40 @@ func (s *MariaDbParameters) SetPort(v int64) *MariaDbParameters { return s } +// An object that consists of the member Amazon Resource Name (ARN) and member +// ID. +type MemberIdArnPair struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the member. + MemberArn *string `type:"string"` + + // The ID of the member. + MemberId *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s MemberIdArnPair) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MemberIdArnPair) GoString() string { + return s.String() +} + +// SetMemberArn sets the MemberArn field's value. +func (s *MemberIdArnPair) SetMemberArn(v string) *MemberIdArnPair { + s.MemberArn = &v + return s +} + +// SetMemberId sets the MemberId field's value. +func (s *MemberIdArnPair) SetMemberId(v string) *MemberIdArnPair { + s.MemberId = &v + return s +} + // MySQL parameters. type MySqlParameters struct { _ struct{} `type:"structure"` @@ -27414,7 +30056,7 @@ func (s *S3Parameters) SetManifestFileLocation(v *ManifestFileLocation) *S3Param return s } -// A physical table type for as S3 data source. +// A physical table type for an S3 data source. type S3Source struct { _ struct{} `type:"structure"` @@ -27423,7 +30065,9 @@ type S3Source struct { // DataSourceArn is a required field DataSourceArn *string `type:"string" required:"true"` - // A physical table type for as S3 data source. + // A physical table type for an S3 data source. + // + // For non-JSON files, only STRING data types are supported in input columns. // // InputColumns is a required field InputColumns []*InputColumn `min:"1" type:"list" required:"true"` @@ -27767,6 +30411,136 @@ func (s *SearchDashboardsOutput) SetStatus(v int64) *SearchDashboardsOutput { return s } +type SearchFoldersInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The filters to apply to the search. Currently, you can search only by the + // parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", + // "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" + // } ]. + // + // Filters is a required field + Filters []*FolderSearchFilter `type:"list" required:"true"` + + // The maximum number of results to be returned per request. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `type:"string"` +} + +// String returns the string representation +func (s SearchFoldersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SearchFoldersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchFoldersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchFoldersInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.Filters == nil { + invalidParams.Add(request.NewErrParamRequired("Filters")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *SearchFoldersInput) SetAwsAccountId(v string) *SearchFoldersInput { + s.AwsAccountId = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *SearchFoldersInput) SetFilters(v []*FolderSearchFilter) *SearchFoldersInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchFoldersInput) SetMaxResults(v int64) *SearchFoldersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchFoldersInput) SetNextToken(v string) *SearchFoldersInput { + s.NextToken = &v + return s +} + +type SearchFoldersOutput struct { + _ struct{} `type:"structure"` + + // A structure that contains all of the folders in your AWS account. This structure + // provides basic information about the folders. + FolderSummaryList []*FolderSummary `type:"list"` + + // The token for the next set of results, or null if there are no more results. + NextToken *string `type:"string"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s SearchFoldersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SearchFoldersOutput) GoString() string { + return s.String() +} + +// SetFolderSummaryList sets the FolderSummaryList field's value. +func (s *SearchFoldersOutput) SetFolderSummaryList(v []*FolderSummary) *SearchFoldersOutput { + s.FolderSummaryList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchFoldersOutput) SetNextToken(v string) *SearchFoldersOutput { + s.NextToken = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *SearchFoldersOutput) SetRequestId(v string) *SearchFoldersOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *SearchFoldersOutput) SetStatus(v int64) *SearchFoldersOutput { + s.Status = &v + return s +} + // ServiceNow parameters. type ServiceNowParameters struct { _ struct{} `type:"structure"` @@ -32053,6 +34827,292 @@ func (s *UpdateDataSourcePermissionsOutput) SetStatus(v int64) *UpdateDataSource return s } +type UpdateFolderInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The name of the folder. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s UpdateFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateFolderInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *UpdateFolderInput) SetAwsAccountId(v string) *UpdateFolderInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *UpdateFolderInput) SetFolderId(v string) *UpdateFolderInput { + s.FolderId = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateFolderInput) SetName(v string) *UpdateFolderInput { + s.Name = &v + return s +} + +type UpdateFolderOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN). + Arn *string `type:"string"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s UpdateFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateFolderOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *UpdateFolderOutput) SetArn(v string) *UpdateFolderOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *UpdateFolderOutput) SetFolderId(v string) *UpdateFolderOutput { + s.FolderId = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *UpdateFolderOutput) SetRequestId(v string) *UpdateFolderOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateFolderOutput) SetStatus(v int64) *UpdateFolderOutput { + s.Status = &v + return s +} + +type UpdateFolderPermissionsInput struct { + _ struct{} `type:"structure"` + + // The AWS account ID. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The folder ID. + // + // FolderId is a required field + FolderId *string `location:"uri" locationName:"FolderId" min:"1" type:"string" required:"true"` + + // The permissions that you want to grant on a resource. + GrantPermissions []*ResourcePermission `min:"1" type:"list"` + + // The permissions that you want to revoke from a resource. + RevokePermissions []*ResourcePermission `min:"1" type:"list"` +} + +// String returns the string representation +func (s UpdateFolderPermissionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateFolderPermissionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateFolderPermissionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateFolderPermissionsInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.FolderId == nil { + invalidParams.Add(request.NewErrParamRequired("FolderId")) + } + if s.FolderId != nil && len(*s.FolderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FolderId", 1)) + } + if s.GrantPermissions != nil && len(s.GrantPermissions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GrantPermissions", 1)) + } + if s.RevokePermissions != nil && len(s.RevokePermissions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RevokePermissions", 1)) + } + if s.GrantPermissions != nil { + for i, v := range s.GrantPermissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "GrantPermissions", i), err.(request.ErrInvalidParams)) + } + } + } + if s.RevokePermissions != nil { + for i, v := range s.RevokePermissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "RevokePermissions", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *UpdateFolderPermissionsInput) SetAwsAccountId(v string) *UpdateFolderPermissionsInput { + s.AwsAccountId = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *UpdateFolderPermissionsInput) SetFolderId(v string) *UpdateFolderPermissionsInput { + s.FolderId = &v + return s +} + +// SetGrantPermissions sets the GrantPermissions field's value. +func (s *UpdateFolderPermissionsInput) SetGrantPermissions(v []*ResourcePermission) *UpdateFolderPermissionsInput { + s.GrantPermissions = v + return s +} + +// SetRevokePermissions sets the RevokePermissions field's value. +func (s *UpdateFolderPermissionsInput) SetRevokePermissions(v []*ResourcePermission) *UpdateFolderPermissionsInput { + s.RevokePermissions = v + return s +} + +type UpdateFolderPermissionsOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN). + Arn *string `type:"string"` + + // The folder ID. + FolderId *string `min:"1" type:"string"` + + // Information about the permissions on the dashboard. + Permissions []*ResourcePermission `min:"1" type:"list"` + + // The request ID. + RequestId *string `type:"string"` + + // The status. If succeeded, the status is SC_OK. + Status *int64 `type:"integer"` +} + +// String returns the string representation +func (s UpdateFolderPermissionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateFolderPermissionsOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *UpdateFolderPermissionsOutput) SetArn(v string) *UpdateFolderPermissionsOutput { + s.Arn = &v + return s +} + +// SetFolderId sets the FolderId field's value. +func (s *UpdateFolderPermissionsOutput) SetFolderId(v string) *UpdateFolderPermissionsOutput { + s.FolderId = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *UpdateFolderPermissionsOutput) SetPermissions(v []*ResourcePermission) *UpdateFolderPermissionsOutput { + s.Permissions = v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *UpdateFolderPermissionsOutput) SetRequestId(v string) *UpdateFolderPermissionsOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateFolderPermissionsOutput) SetStatus(v int64) *UpdateFolderPermissionsOutput { + s.Status = &v + return s +} + type UpdateGroupInput struct { _ struct{} `type:"structure"` @@ -34356,6 +37416,30 @@ func FilterOperator_Values() []string { } } +const ( + // FolderFilterAttributeParentFolderArn is a FolderFilterAttribute enum value + FolderFilterAttributeParentFolderArn = "PARENT_FOLDER_ARN" +) + +// FolderFilterAttribute_Values returns all elements of the FolderFilterAttribute enum +func FolderFilterAttribute_Values() []string { + return []string{ + FolderFilterAttributeParentFolderArn, + } +} + +const ( + // FolderTypeShared is a FolderType enum value + FolderTypeShared = "SHARED" +) + +// FolderType_Values returns all elements of the FolderType enum +func FolderType_Values() []string { + return []string{ + FolderTypeShared, + } +} + const ( // GeoSpatialCountryCodeUs is a GeoSpatialCountryCode enum value GeoSpatialCountryCodeUs = "US" @@ -34732,6 +37816,26 @@ func JoinType_Values() []string { } } +const ( + // MemberTypeDashboard is a MemberType enum value + MemberTypeDashboard = "DASHBOARD" + + // MemberTypeAnalysis is a MemberType enum value + MemberTypeAnalysis = "ANALYSIS" + + // MemberTypeDataset is a MemberType enum value + MemberTypeDataset = "DATASET" +) + +// MemberType_Values returns all elements of the MemberType enum +func MemberType_Values() []string { + return []string{ + MemberTypeDashboard, + MemberTypeAnalysis, + MemberTypeDataset, + } +} + const ( // NamespaceErrorTypePermissionDenied is a NamespaceErrorType enum value NamespaceErrorTypePermissionDenied = "PERMISSION_DENIED" diff --git a/service/quicksight/quicksightiface/interface.go b/service/quicksight/quicksightiface/interface.go index 3c1709747fb..9dd496de123 100644 --- a/service/quicksight/quicksightiface/interface.go +++ b/service/quicksight/quicksightiface/interface.go @@ -84,6 +84,14 @@ type QuickSightAPI interface { CreateDataSourceWithContext(aws.Context, *quicksight.CreateDataSourceInput, ...request.Option) (*quicksight.CreateDataSourceOutput, error) CreateDataSourceRequest(*quicksight.CreateDataSourceInput) (*request.Request, *quicksight.CreateDataSourceOutput) + CreateFolder(*quicksight.CreateFolderInput) (*quicksight.CreateFolderOutput, error) + CreateFolderWithContext(aws.Context, *quicksight.CreateFolderInput, ...request.Option) (*quicksight.CreateFolderOutput, error) + CreateFolderRequest(*quicksight.CreateFolderInput) (*request.Request, *quicksight.CreateFolderOutput) + + CreateFolderMembership(*quicksight.CreateFolderMembershipInput) (*quicksight.CreateFolderMembershipOutput, error) + CreateFolderMembershipWithContext(aws.Context, *quicksight.CreateFolderMembershipInput, ...request.Option) (*quicksight.CreateFolderMembershipOutput, error) + CreateFolderMembershipRequest(*quicksight.CreateFolderMembershipInput) (*request.Request, *quicksight.CreateFolderMembershipOutput) + CreateGroup(*quicksight.CreateGroupInput) (*quicksight.CreateGroupOutput, error) CreateGroupWithContext(aws.Context, *quicksight.CreateGroupInput, ...request.Option) (*quicksight.CreateGroupOutput, error) CreateGroupRequest(*quicksight.CreateGroupInput) (*request.Request, *quicksight.CreateGroupOutput) @@ -140,6 +148,14 @@ type QuickSightAPI interface { DeleteDataSourceWithContext(aws.Context, *quicksight.DeleteDataSourceInput, ...request.Option) (*quicksight.DeleteDataSourceOutput, error) DeleteDataSourceRequest(*quicksight.DeleteDataSourceInput) (*request.Request, *quicksight.DeleteDataSourceOutput) + DeleteFolder(*quicksight.DeleteFolderInput) (*quicksight.DeleteFolderOutput, error) + DeleteFolderWithContext(aws.Context, *quicksight.DeleteFolderInput, ...request.Option) (*quicksight.DeleteFolderOutput, error) + DeleteFolderRequest(*quicksight.DeleteFolderInput) (*request.Request, *quicksight.DeleteFolderOutput) + + DeleteFolderMembership(*quicksight.DeleteFolderMembershipInput) (*quicksight.DeleteFolderMembershipOutput, error) + DeleteFolderMembershipWithContext(aws.Context, *quicksight.DeleteFolderMembershipInput, ...request.Option) (*quicksight.DeleteFolderMembershipOutput, error) + DeleteFolderMembershipRequest(*quicksight.DeleteFolderMembershipInput) (*request.Request, *quicksight.DeleteFolderMembershipOutput) + DeleteGroup(*quicksight.DeleteGroupInput) (*quicksight.DeleteGroupOutput, error) DeleteGroupWithContext(aws.Context, *quicksight.DeleteGroupInput, ...request.Option) (*quicksight.DeleteGroupOutput, error) DeleteGroupRequest(*quicksight.DeleteGroupInput) (*request.Request, *quicksight.DeleteGroupOutput) @@ -220,6 +236,18 @@ type QuickSightAPI interface { DescribeDataSourcePermissionsWithContext(aws.Context, *quicksight.DescribeDataSourcePermissionsInput, ...request.Option) (*quicksight.DescribeDataSourcePermissionsOutput, error) DescribeDataSourcePermissionsRequest(*quicksight.DescribeDataSourcePermissionsInput) (*request.Request, *quicksight.DescribeDataSourcePermissionsOutput) + DescribeFolder(*quicksight.DescribeFolderInput) (*quicksight.DescribeFolderOutput, error) + DescribeFolderWithContext(aws.Context, *quicksight.DescribeFolderInput, ...request.Option) (*quicksight.DescribeFolderOutput, error) + DescribeFolderRequest(*quicksight.DescribeFolderInput) (*request.Request, *quicksight.DescribeFolderOutput) + + DescribeFolderPermissions(*quicksight.DescribeFolderPermissionsInput) (*quicksight.DescribeFolderPermissionsOutput, error) + DescribeFolderPermissionsWithContext(aws.Context, *quicksight.DescribeFolderPermissionsInput, ...request.Option) (*quicksight.DescribeFolderPermissionsOutput, error) + DescribeFolderPermissionsRequest(*quicksight.DescribeFolderPermissionsInput) (*request.Request, *quicksight.DescribeFolderPermissionsOutput) + + DescribeFolderResolvedPermissions(*quicksight.DescribeFolderResolvedPermissionsInput) (*quicksight.DescribeFolderResolvedPermissionsOutput, error) + DescribeFolderResolvedPermissionsWithContext(aws.Context, *quicksight.DescribeFolderResolvedPermissionsInput, ...request.Option) (*quicksight.DescribeFolderResolvedPermissionsOutput, error) + DescribeFolderResolvedPermissionsRequest(*quicksight.DescribeFolderResolvedPermissionsInput) (*request.Request, *quicksight.DescribeFolderResolvedPermissionsOutput) + DescribeGroup(*quicksight.DescribeGroupInput) (*quicksight.DescribeGroupOutput, error) DescribeGroupWithContext(aws.Context, *quicksight.DescribeGroupInput, ...request.Option) (*quicksight.DescribeGroupOutput, error) DescribeGroupRequest(*quicksight.DescribeGroupInput) (*request.Request, *quicksight.DescribeGroupOutput) @@ -307,6 +335,14 @@ type QuickSightAPI interface { ListDataSourcesPages(*quicksight.ListDataSourcesInput, func(*quicksight.ListDataSourcesOutput, bool) bool) error ListDataSourcesPagesWithContext(aws.Context, *quicksight.ListDataSourcesInput, func(*quicksight.ListDataSourcesOutput, bool) bool, ...request.Option) error + ListFolderMembers(*quicksight.ListFolderMembersInput) (*quicksight.ListFolderMembersOutput, error) + ListFolderMembersWithContext(aws.Context, *quicksight.ListFolderMembersInput, ...request.Option) (*quicksight.ListFolderMembersOutput, error) + ListFolderMembersRequest(*quicksight.ListFolderMembersInput) (*request.Request, *quicksight.ListFolderMembersOutput) + + ListFolders(*quicksight.ListFoldersInput) (*quicksight.ListFoldersOutput, error) + ListFoldersWithContext(aws.Context, *quicksight.ListFoldersInput, ...request.Option) (*quicksight.ListFoldersOutput, error) + ListFoldersRequest(*quicksight.ListFoldersInput) (*request.Request, *quicksight.ListFoldersOutput) + ListGroupMemberships(*quicksight.ListGroupMembershipsInput) (*quicksight.ListGroupMembershipsOutput, error) ListGroupMembershipsWithContext(aws.Context, *quicksight.ListGroupMembershipsInput, ...request.Option) (*quicksight.ListGroupMembershipsOutput, error) ListGroupMembershipsRequest(*quicksight.ListGroupMembershipsInput) (*request.Request, *quicksight.ListGroupMembershipsOutput) @@ -410,6 +446,10 @@ type QuickSightAPI interface { SearchDashboardsPages(*quicksight.SearchDashboardsInput, func(*quicksight.SearchDashboardsOutput, bool) bool) error SearchDashboardsPagesWithContext(aws.Context, *quicksight.SearchDashboardsInput, func(*quicksight.SearchDashboardsOutput, bool) bool, ...request.Option) error + SearchFolders(*quicksight.SearchFoldersInput) (*quicksight.SearchFoldersOutput, error) + SearchFoldersWithContext(aws.Context, *quicksight.SearchFoldersInput, ...request.Option) (*quicksight.SearchFoldersOutput, error) + SearchFoldersRequest(*quicksight.SearchFoldersInput) (*request.Request, *quicksight.SearchFoldersOutput) + TagResource(*quicksight.TagResourceInput) (*quicksight.TagResourceOutput, error) TagResourceWithContext(aws.Context, *quicksight.TagResourceInput, ...request.Option) (*quicksight.TagResourceOutput, error) TagResourceRequest(*quicksight.TagResourceInput) (*request.Request, *quicksight.TagResourceOutput) @@ -462,6 +502,14 @@ type QuickSightAPI interface { UpdateDataSourcePermissionsWithContext(aws.Context, *quicksight.UpdateDataSourcePermissionsInput, ...request.Option) (*quicksight.UpdateDataSourcePermissionsOutput, error) UpdateDataSourcePermissionsRequest(*quicksight.UpdateDataSourcePermissionsInput) (*request.Request, *quicksight.UpdateDataSourcePermissionsOutput) + UpdateFolder(*quicksight.UpdateFolderInput) (*quicksight.UpdateFolderOutput, error) + UpdateFolderWithContext(aws.Context, *quicksight.UpdateFolderInput, ...request.Option) (*quicksight.UpdateFolderOutput, error) + UpdateFolderRequest(*quicksight.UpdateFolderInput) (*request.Request, *quicksight.UpdateFolderOutput) + + UpdateFolderPermissions(*quicksight.UpdateFolderPermissionsInput) (*quicksight.UpdateFolderPermissionsOutput, error) + UpdateFolderPermissionsWithContext(aws.Context, *quicksight.UpdateFolderPermissionsInput, ...request.Option) (*quicksight.UpdateFolderPermissionsOutput, error) + UpdateFolderPermissionsRequest(*quicksight.UpdateFolderPermissionsInput) (*request.Request, *quicksight.UpdateFolderPermissionsOutput) + UpdateGroup(*quicksight.UpdateGroupInput) (*quicksight.UpdateGroupOutput, error) UpdateGroupWithContext(aws.Context, *quicksight.UpdateGroupInput, ...request.Option) (*quicksight.UpdateGroupOutput, error) UpdateGroupRequest(*quicksight.UpdateGroupInput) (*request.Request, *quicksight.UpdateGroupOutput)