The specified Amazon Resource Name (ARN) does not exist in the AWS account.
", + "smithy.api#documentation": "The specified Amazon Resource Name (ARN) does not exist in the Amazon Web Services account.
", "smithy.api#error": "client" } }, @@ -359,7 +359,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified approval rule template does not exist. Verify that the name is correct and that you are signed in to the AWS Region where the template\n was created, and then try again.
", + "smithy.api#documentation": "The specified approval rule template does not exist. Verify that the name is correct and that you are signed in to the Amazon Web Services Region where the template\n was created, and then try again.
", "smithy.api#error": "client" } }, @@ -401,7 +401,7 @@ } }, "traits": { - "smithy.api#documentation": "You cannot create an approval rule template with that name because a template with\n that name already exists in this AWS Region for your AWS account. Approval rule template\n names must be unique.
", + "smithy.api#documentation": "You cannot create an approval rule template with that name because a template with\n that name already exists in this Amazon Web Services Region for your Amazon Web Services account. Approval rule template\n names must be unique.
", "smithy.api#error": "client" } }, @@ -445,18 +445,20 @@ } }, "com.amazonaws.codecommit#ApprovalState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPROVE", - "name": "APPROVE" - }, - { - "value": "REVOKE", - "name": "REVOKE" + "type": "enum", + "members": { + "APPROVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVE" } - ] + }, + "REVOKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE" + } + } } }, "com.amazonaws.codecommit#ApprovalStateChangedEventMetadata": { @@ -570,6 +572,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#AuthorDoesNotExistException": { @@ -583,7 +588,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified Amazon Resource Name (ARN) does not exist in the AWS account.
", + "smithy.api#documentation": "The specified Amazon Resource Name (ARN) does not exist in the Amazon Web Services account.
", "smithy.api#error": "client" } }, @@ -676,10 +681,13 @@ "repositoryNames": { "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { - "smithy.api#documentation": "The names of the repositories you want to associate with the template.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nThe names of the repositories you want to associate with the template.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nAn enumeration token that, when provided in a request, returns the next batch of the\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#BatchDescribeMergeConflictsOutput": { @@ -924,6 +938,9 @@ "smithy.api#documentation": "The commit ID of the merge base.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#BatchDisassociateApprovalRuleTemplateFromRepositories": { @@ -1015,10 +1032,13 @@ "repositoryNames": { "target": "com.amazonaws.codecommit#RepositoryNameList", "traits": { - "smithy.api#documentation": "The repository names that you want to disassociate from the approval rule\n template.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nThe repository names that you want to disassociate from the approval rule\n template.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nThe full commit IDs of the commits to get information about.
\nYou must supply the full SHA IDs of each commit. You cannot use shortened SHA\n IDs.
\nThe full commit IDs of the commits to get information about.
\nYou must supply the full SHA IDs of each commit. You cannot use shortened SHA\n IDs.
\nReturns any commit IDs for which information could not be found. For example, if one\n of the commit IDs was a shortened SHA ID or that commit was not found in the specified\n repository, the ID returns an error object with more information.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#BatchGetRepositories": { @@ -1187,7 +1216,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about one or more repositories.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nReturns information about one or more repositories.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nThe names of the repositories to get information about.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nThe names of the repositories to get information about.
\nThe length constraint limit is for each string in the array. The array itself can be empty.
\nRepresents the input of a batch get repositories operation.
" + "smithy.api#documentation": "Represents the input of a batch get repositories operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#BatchGetRepositoriesOutput": { @@ -1222,7 +1252,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a batch get repositories operation.
" + "smithy.api#documentation": "Represents the output of a batch get repositories operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#BeforeCommitIdAndAfterCommitIdAreSameException": { @@ -1288,7 +1319,7 @@ "mode": { "target": "com.amazonaws.codecommit#Mode", "traits": { - "smithy.api#documentation": "The file mode permissions of the blob. File mode permission codes include:
\n\n 100644 indicates read/write
\n 100755 indicates read/write/execute
\n 160000 indicates a submodule
\n 120000 indicates a symlink
The file mode permissions of the blob. File mode permission codes include:
\n\n 100644 indicates read/write
\n 100755 indicates read/write/execute
\n 160000 indicates a submodule
\n 120000 indicates a symlink
Cannot create the branch with the specified name because the commit conflicts with an existing branch with the same name. \n Branch names must be unique.
", + "smithy.api#documentation": "Cannot create the branch with the specified name because the commit conflicts with an existing branch with the same name. \n\n Branch names must be unique.
", "smithy.api#error": "client" } }, @@ -1431,22 +1462,26 @@ "type": "boolean" }, "com.amazonaws.codecommit#ChangeTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "A", - "name": "ADDED" - }, - { - "value": "M", - "name": "MODIFIED" - }, - { - "value": "D", - "name": "DELETED" + "type": "enum", + "members": { + "ADDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A" + } + }, + "MODIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "M" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "D" } - ] + } } }, "com.amazonaws.codecommit#ClientRequestToken": { @@ -1612,6 +1647,9 @@ { "target": "com.amazonaws.codecommit#ListBranches" }, + { + "target": "com.amazonaws.codecommit#ListFileCommitHistory" + }, { "target": "com.amazonaws.codecommit#ListPullRequests" }, @@ -1721,7 +1759,7 @@ "name": "codecommit" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for \n AWS CodeCommit API along with usage examples.
\nYou can use the AWS CodeCommit API to work with the following objects:
\n \nRepositories, by calling the following:
\n\n BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.
\n\n CreateRepository, which creates an AWS CodeCommit repository.
\n\n DeleteRepository, which deletes an AWS CodeCommit repository.
\n\n GetRepository, which returns information about a specified repository.
\n\n ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.
\n\n UpdateRepositoryDescription, which sets or updates the description of the repository.
\n\n UpdateRepositoryName, which changes the name of the\n repository. If you change the name of a repository, no other users of that\n repository can access it until you send them the new HTTPS or SSH URL to\n use.
\nBranches, by calling the following:
\n\n CreateBranch, which creates a branch in a specified\n repository.
\n\n DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
\n\n GetBranch, which returns information about a specified branch.
\n\n ListBranches, which lists all branches for a specified repository.
\n\n UpdateDefaultBranch, which changes the default branch for a repository.
\nFiles, by calling the following:
\n\n DeleteFile, which deletes the content of a specified file from a specified branch.
\n\n GetBlob, which returns the base-64 encoded content of an\n individual Git blob object in a repository.
\n\n GetFile, which returns the base-64 encoded content of a specified file.
\n\n GetFolder, which returns the contents of a specified folder or directory.
\n\n PutFile, which adds or modifies a single file in a specified repository and branch.
\nCommits, by calling the following:
\n\n BatchGetCommits, which returns information about one or more commits in a repository.
\n\n CreateCommit, which creates a commit for changes to a repository.
\n\n GetCommit, which returns information about a commit, including commit \n messages and author and committer information.
\n\n GetDifferences, which returns information about the\n differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID,\n or other fully qualified reference).
\nMerges, by calling the following:
\n\n BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.
\n\n CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the\n purpose of comparing them and identifying any potential conflicts.
\n\n DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions\n of a file in a potential merge.
\n\n GetMergeCommit, which returns information about the merge between a source and destination commit.
\n\n\n GetMergeConflicts, which returns information about merge conflicts\n between the source and destination branch in a pull request.
\n\n GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.
\n\n MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.
\n\n MergeBranchesBySquash, which merges two branches using the squash merge option.
\n\n MergeBranchesByThreeWay, which merges two branches using the three-way merge option.
\nPull requests, by calling the following:
\n\n CreatePullRequest, which creates a pull request in a specified repository.
\n\n CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.
\n\n DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.
\n\n DescribePullRequestEvents, which returns information about one or more pull request events.
\n\n EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.
\n\n GetCommentsForPullRequest, which returns information about comments on a specified pull request.
\n\n GetPullRequest, which returns information about a specified pull request.
\n\n GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.
\n\n GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) for a \n pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.
\n\n ListPullRequests, which lists all pull requests for a repository.
\n\n MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the fast-forward merge option.
\n\n MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the squash merge option.
\n\n MergePullRequestByThreeWay. which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the three-way merge option.
\n\n OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.
\n\n PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
\n\n UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.
\n\n UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.
\n\n UpdatePullRequestDescription, which updates the description of a pull request.
\n\n UpdatePullRequestStatus, which updates the status of a pull request.
\n\n UpdatePullRequestTitle, which updates the title of a pull request.
\nApproval rule templates, by calling the following:
\n\n AssociateApprovalRuleTemplateWithRepository, which associates a template\n with a specified repository. After the template is associated with a repository,\n AWS CodeCommit creates approval rules that match the template conditions on\n every pull request created in the specified repository.
\n\n BatchAssociateApprovalRuleTemplateWithRepositories, which associates a\n template with one or more specified repositories. After the template is\n associated with a repository, AWS CodeCommit creates approval rules that match\n the template conditions on every pull request created in the specified\n repositories.
\n\n BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the\n association between a template and specified repositories so that approval rules\n based on the template are not automatically created when pull requests are\n created in those repositories.
\n\n CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories\n in your AWS account.
\n\n DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.
\n\n DisassociateApprovalRuleTemplateFromRepository, which removes the\n association between a template and a repository so that approval rules based on\n the template are not automatically created when pull requests are created in the\n specified repository.
\n\n GetApprovalRuleTemplate, which returns information about an approval rule template.
\n\n ListApprovalRuleTemplates, which lists all approval rule templates in the AWS Region in your AWS account.
\n\n ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.
\n\n ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.
\n\n UpdateApprovalRuleTemplateDescription, which updates the description of an\n approval rule template.
\n\n UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.
\n\n UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.
\nComments in a repository, by calling the following:
\n\n DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
\n\n GetComment, which returns information about a comment on a commit.
\n\n GetCommentReactions, which returns information about emoji reactions to comments.
\n\n GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers \n in a repository.
\n\n PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
\n\n PostCommentReply, which creates a reply to a comment.
\n\n PutCommentReaction, which creates or updates an emoji reaction to a comment.
\n\n UpdateComment, which updates the content of a comment on a commit in a repository.
\nTags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:
\n\n ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.
\n\n TagResource, which adds or updates tags for a resource in AWS CodeCommit.
\n\n UntagResource, which removes tags for a resource in AWS CodeCommit.
\nTriggers, by calling the following:
\n\n GetRepositoryTriggers, which returns information about triggers configured \n for a repository.
\n\n PutRepositoryTriggers, which replaces all triggers for a repository and can \n be used to create or delete triggers.
\n\n TestRepositoryTriggers, which tests the functionality of a repository trigger \n by sending data to the trigger target.
\nFor information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.
", + "smithy.api#documentation": "This is the CodeCommit API Reference. This reference provides descriptions of the operations and data types for \n CodeCommit API along with usage examples.
\nYou can use the CodeCommit API to work with the following objects:
\nRepositories, by calling the following:
\n\n BatchGetRepositories, which returns information about one or more repositories associated with your Amazon Web Services account.
\n\n CreateRepository, which creates an CodeCommit repository.
\n\n DeleteRepository, which deletes an CodeCommit repository.
\n\n GetRepository, which returns information about a specified repository.
\n\n ListRepositories, which lists all CodeCommit repositories associated with your Amazon Web Services account.
\n\n UpdateRepositoryDescription, which sets or updates the description of the repository.
\n\n UpdateRepositoryName, which changes the name of the\n repository. If you change the name of a repository, no other users of that\n repository can access it until you send them the new HTTPS or SSH URL to\n use.
\nBranches, by calling the following:
\n\n CreateBranch, which creates a branch in a specified\n repository.
\n\n DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
\n\n GetBranch, which returns information about a specified branch.
\n\n ListBranches, which lists all branches for a specified repository.
\n\n UpdateDefaultBranch, which changes the default branch for a repository.
\nFiles, by calling the following:
\n\n DeleteFile, which deletes the content of a specified file from a specified branch.
\n\n GetBlob, which returns the base-64 encoded content of an\n individual Git blob object in a repository.
\n\n GetFile, which returns the base-64 encoded content of a specified file.
\n\n GetFolder, which returns the contents of a specified folder or directory.
\n\n ListFileCommitHistory, which retrieves a list of commits and changes to a specified file.
\n\n PutFile, which adds or modifies a single file in a specified repository and branch.
\nCommits, by calling the following:
\n\n BatchGetCommits, which returns information about one or more commits in a repository.
\n\n CreateCommit, which creates a commit for changes to a repository.
\n\n GetCommit, which returns information about a commit, including commit \n messages and author and committer information.
\n\n GetDifferences, which returns information about the\n differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID,\n or other fully qualified reference).
\nMerges, by calling the following:
\n\n BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.
\n\n CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the\n purpose of comparing them and identifying any potential conflicts.
\n\n DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions\n of a file in a potential merge.
\n\n GetMergeCommit, which returns information about the merge between a source and destination commit.
\n\n GetMergeConflicts, which returns information about merge conflicts\n between the source and destination branch in a pull request.
\n\n GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.
\n\n MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.
\n\n MergeBranchesBySquash, which merges two branches using the squash merge option.
\n\n MergeBranchesByThreeWay, which merges two branches using the three-way merge option.
\nPull requests, by calling the following:
\n\n CreatePullRequest, which creates a pull request in a specified repository.
\n\n CreatePullRequestApprovalRule, which creates an approval rule for a specified pull request.
\n\n DeletePullRequestApprovalRule, which deletes an approval rule for a specified pull request.
\n\n DescribePullRequestEvents, which returns information about one or more pull request events.
\n\n EvaluatePullRequestApprovalRules, which evaluates whether a pull request has met all the conditions specified in its associated approval rules.
\n\n GetCommentsForPullRequest, which returns information about comments on a specified pull request.
\n\n GetPullRequest, which returns information about a specified pull request.
\n\n GetPullRequestApprovalStates, which returns information about the approval states for a specified pull request.
\n\n GetPullRequestOverrideState, which returns information about whether approval rules have been set aside (overriden) for a \n pull request, and if so, the Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.
\n\n ListPullRequests, which lists all pull requests for a repository.
\n\n MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the fast-forward merge option.
\n\n MergePullRequestBySquash, which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the squash merge option.
\n\n MergePullRequestByThreeWay, which merges the source destination branch of a pull request into the specified destination\n branch for that pull request using the three-way merge option.
\n\n OverridePullRequestApprovalRules, which sets aside all approval rule requirements for a pull request.
\n\n PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
\n\n UpdatePullRequestApprovalRuleContent, which updates the structure of an approval rule for a pull request.
\n\n UpdatePullRequestApprovalState, which updates the state of an approval on a pull request.
\n\n UpdatePullRequestDescription, which updates the description of a pull request.
\n\n UpdatePullRequestStatus, which updates the status of a pull request.
\n\n UpdatePullRequestTitle, which updates the title of a pull request.
\nApproval rule templates, by calling the following:
\n\n AssociateApprovalRuleTemplateWithRepository, which associates a template\n with a specified repository. After the template is associated with a repository,\n CodeCommit creates approval rules that match the template conditions on\n every pull request created in the specified repository.
\n\n BatchAssociateApprovalRuleTemplateWithRepositories, which associates a\n template with one or more specified repositories. After the template is\n associated with a repository, CodeCommit creates approval rules that match\n the template conditions on every pull request created in the specified\n repositories.
\n\n BatchDisassociateApprovalRuleTemplateFromRepositories, which removes the\n association between a template and specified repositories so that approval rules\n based on the template are not automatically created when pull requests are\n created in those repositories.
\n\n CreateApprovalRuleTemplate, which creates a template for approval rules that can then be associated with one or more repositories\n in your Amazon Web Services account.
\n\n DeleteApprovalRuleTemplate, which deletes the specified template. It does not remove approval rules on pull requests already created with the template.
\n\n DisassociateApprovalRuleTemplateFromRepository, which removes the\n association between a template and a repository so that approval rules based on\n the template are not automatically created when pull requests are created in the\n specified repository.
\n\n GetApprovalRuleTemplate, which returns information about an approval rule template.
\n\n ListApprovalRuleTemplates, which lists all approval rule templates in the Amazon Web Services Region in your Amazon Web Services account.
\n\n ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval rule templates that are associated with a specified repository.
\n\n ListRepositoriesForApprovalRuleTemplate, which lists all repositories associated with the specified approval rule template.
\n\n UpdateApprovalRuleTemplateDescription, which updates the description of an\n approval rule template.
\n\n UpdateApprovalRuleTemplateName, which updates the name of an approval rule template.
\n\n UpdateApprovalRuleTemplateContent, which updates the content of an approval rule template.
\nComments in a repository, by calling the following:
\n\n DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
\n\n GetComment, which returns information about a comment on a commit.
\n\n GetCommentReactions, which returns information about emoji reactions to comments.
\n\n GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers \n in a repository.
\n\n PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
\n\n PostCommentReply, which creates a reply to a comment.
\n\n PutCommentReaction, which creates or updates an emoji reaction to a comment.
\n\n UpdateComment, which updates the content of a comment on a commit in a repository.
\nTags used to tag resources in CodeCommit (not Git tags), by calling the following:
\n\n ListTagsForResource, which gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit.
\n\n TagResource, which adds or updates tags for a resource in CodeCommit.
\n\n UntagResource, which removes tags for a resource in CodeCommit.
\nTriggers, by calling the following:
\n\n GetRepositoryTriggers, which returns information about triggers configured \n for a repository.
\n\n PutRepositoryTriggers, which replaces all triggers for a repository and can \n be used to create or delete triggers.
\n\n TestRepositoryTriggers, which tests the functionality of a repository trigger \n by sending data to the trigger target.
\nFor information about how to use CodeCommit, see the CodeCommit User Guide.
", "smithy.api#title": "AWS CodeCommit", "smithy.api#xmlNamespace": { "uri": "http://codecommit.amazonaws.com/doc/2015-04-13" @@ -1786,52 +1824,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1839,13 +1881,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1855,224 +1906,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://codecommit-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://codecommit-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://codecommit-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://codecommit-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://codecommit.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://codecommit.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://codecommit.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://codecommit.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2087,8 +2089,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2100,8 +2102,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2113,8 +2115,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2126,8 +2128,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2139,8 +2141,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2152,8 +2154,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2165,8 +2167,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2178,8 +2180,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2191,8 +2193,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2204,8 +2206,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2217,8 +2219,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2230,8 +2232,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2243,8 +2245,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2256,8 +2258,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2269,8 +2271,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2282,8 +2284,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2295,8 +2297,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2308,8 +2310,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2321,8 +2323,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2334,8 +2336,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2347,8 +2349,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2360,8 +2362,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2373,8 +2375,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2386,8 +2388,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2399,8 +2401,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2412,8 +2414,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2425,8 +2427,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2438,8 +2440,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2451,8 +2453,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2464,8 +2466,8 @@ }, "params": { "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2477,8 +2479,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2490,8 +2492,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2503,8 +2505,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2516,8 +2518,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2529,8 +2531,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2542,8 +2544,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2555,8 +2557,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2568,8 +2570,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2581,8 +2583,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2594,8 +2607,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2607,8 +2631,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2620,8 +2655,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2633,8 +2679,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2646,8 +2692,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2659,8 +2705,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2671,8 +2717,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2683,10 +2729,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -2788,7 +2840,7 @@ } }, "traits": { - "smithy.api#documentation": "The comment is too large. Comments are limited to 1,000 characters.
", + "smithy.api#documentation": "The comment is too large. Comments are limited to 10,240 characters.
", "smithy.api#error": "client" } }, @@ -3015,7 +3067,7 @@ "committer": { "target": "com.amazonaws.codecommit#UserInfo", "traits": { - "smithy.api#documentation": "Information about the person who committed the specified commit, also known as the committer. Information includes \n the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured \n in Git.
\nFor more information\n about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git\n by Scott Chacon and Ben Straub.
" + "smithy.api#documentation": "Information about the person who committed the specified commit, also known as the committer. Information includes \n the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured \n in Git.
\nFor more information\n about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git\n by Scott Chacon and Ben Straub.
" } }, "additionalData": { @@ -3188,18 +3240,20 @@ } }, "com.amazonaws.codecommit#ConflictDetailLevelTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FILE_LEVEL", - "name": "FILE_LEVEL" - }, - { - "value": "LINE_LEVEL", - "name": "LINE_LEVEL" + "type": "enum", + "members": { + "FILE_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_LEVEL" } - ] + }, + "LINE_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE_LEVEL" + } + } } }, "com.amazonaws.codecommit#ConflictMetadata": { @@ -3307,26 +3361,32 @@ } }, "com.amazonaws.codecommit#ConflictResolutionStrategyTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "ACCEPT_SOURCE", - "name": "ACCEPT_SOURCE" - }, - { - "value": "ACCEPT_DESTINATION", - "name": "ACCEPT_DESTINATION" - }, - { - "value": "AUTOMERGE", - "name": "AUTOMERGE" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ACCEPT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT_SOURCE" + } + }, + "ACCEPT_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT_DESTINATION" + } + }, + "AUTOMERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMERGE" } - ] + } } }, "com.amazonaws.codecommit#Conflicts": { @@ -3373,7 +3433,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a template for approval rules that can then be associated with one or more\n repositories in your AWS account. When you associate a template with a repository, AWS\n CodeCommit creates an approval rule that matches the conditions of the template for all\n pull requests that meet the conditions of the template. For more information, see\n AssociateApprovalRuleTemplateWithRepository.
" + "smithy.api#documentation": "Creates a template for approval rules that can then be associated with one or more\n repositories in your Amazon Web Services account. When you associate a template with a repository, \n CodeCommit creates an approval rule that matches the conditions of the template for all\n pull requests that meet the conditions of the template. For more information, see\n AssociateApprovalRuleTemplateWithRepository.
" } }, "com.amazonaws.codecommit#CreateApprovalRuleTemplateInput": { @@ -3389,7 +3449,7 @@ "approvalRuleTemplateContent": { "target": "com.amazonaws.codecommit#ApprovalRuleTemplateContent", "traits": { - "smithy.api#documentation": "The content of the approval rule that is created on pull requests in associated\n repositories. If you specify one or more destination references (branches), approval\n rules are created in an associated repository only if their destination references\n (branches) match those specified in the template.
\nWhen you create the content of the approval rule template, you can specify\n approvers in an approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.
\n \nThe content of the approval rule that is created on pull requests in associated\n repositories. If you specify one or more destination references (branches), approval\n rules are created in an associated repository only if their destination references\n (branches) match those specified in the template.
\nWhen you create the content of the approval rule template, you can specify\n approvers in an approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an Amazon Web Services account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the Amazon Web Services account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.
\nThe description of the approval rule template. Consider providing a description that\n explains what this template does and when it might be appropriate to associate it with\n repositories.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#CreateApprovalRuleTemplateOutput": { @@ -3411,6 +3474,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#CreateBranch": { @@ -3466,7 +3532,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a branch in a repository and points the branch to a commit.
\nCalling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.
\nCreates a branch in a repository and points the branch to a commit.
\nCalling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.
\nRepresents the input of a create branch operation.
" + "smithy.api#documentation": "Represents the input of a create branch operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#CreateCommit": { @@ -3692,6 +3759,9 @@ "smithy.api#documentation": "The file modes to update for files in this commit.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#CreateCommitOutput": { @@ -3727,6 +3797,9 @@ "smithy.api#documentation": "The files deleted as part of the committed file changes.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#CreatePullRequest": { @@ -3897,10 +3970,13 @@ "approvalRuleContent": { "target": "com.amazonaws.codecommit#ApprovalRuleContent", "traits": { - "smithy.api#documentation": "The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information\n about approval pools, see the AWS CodeCommit User Guide.
\nWhen you create the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following would be counted\n as approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see\n IAM\n Identifiers in the IAM User Guide.
\n \nThe content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information\n about approval pools, see the CodeCommit User Guide.
\nWhen you create the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an Amazon Web Services account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the Amazon Web Services account 123456789012\n and Mary_Major, all of the following would be counted\n as approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see\n IAM\n Identifiers in the IAM User Guide.
\nA unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.
\nThe AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an\n idempotency token is created for you.
\nA unique, client-generated idempotency token that, when provided in a request, ensures\n the request cannot be repeated with a changed parameter. If a request is received with\n the same parameters and a token is included, the request returns information about the\n initial request that used that token.
\nThe Amazon Web ServicesSDKs prepopulate client request tokens. If you are using an Amazon Web ServicesSDK, an\n idempotency token is created for you.
\nThe name of the new repository to be created.
\nThe repository name must be unique across the calling AWS account. Repository names\n are limited to 100 alphanumeric, dash, and underscore characters, and cannot include\n certain characters. For more information about the limits on repository names, see\n Limits in the AWS CodeCommit User Guide. The\n suffix .git is prohibited.
\nThe name of the new repository to be created.
\nThe repository name must be unique across the calling Amazon Web Services account. Repository names\n are limited to 100 alphanumeric, dash, and underscore characters, and cannot include\n certain characters. For more information about the limits on repository names, see\n Quotas in the CodeCommit User Guide. The\n suffix .git is prohibited.
\nA comment or description about the new repository.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nA comment or description about the new repository.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nRepresents the input of a create repository operation.
" + "smithy.api#documentation": "Represents the input of a create repository operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#CreateRepositoryOutput": { @@ -4053,7 +4139,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a create repository operation.
" + "smithy.api#documentation": "Represents the output of a create repository operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#CreateUnreferencedMergeCommit": { @@ -4175,7 +4262,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an unreferenced commit that represents the result of merging two branches\n using a specified merge strategy. This can help you determine the outcome of a potential\n merge. This API cannot be used with the fast-forward merge strategy because that\n strategy does not create a merge commit.
\nThis unreferenced merge commit \n can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.
\nCreates an unreferenced commit that represents the result of merging two branches\n using a specified merge strategy. This can help you determine the outcome of a potential\n merge. This API cannot be used with the fast-forward merge strategy because that\n strategy does not create a merge commit.
\nThis unreferenced merge commit \n can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.
\nIf AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#CreateUnreferencedMergeCommitOutput": { @@ -4269,6 +4359,9 @@ "smithy.api#documentation": "The full SHA-1 pointer of the tree information for the commit that contains the merge results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#CreationDate": { @@ -4325,6 +4418,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeleteApprovalRuleTemplateOutput": { @@ -4337,6 +4433,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DeleteBranch": { @@ -4405,7 +4504,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a delete branch operation.
" + "smithy.api#documentation": "Represents the input of a delete branch operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeleteBranchOutput": { @@ -4419,7 +4519,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a delete branch operation.
" + "smithy.api#documentation": "Represents the output of a delete branch operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DeleteCommentContent": { @@ -4458,6 +4559,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeleteCommentContentOutput": { @@ -4469,6 +4573,9 @@ "smithy.api#documentation": "Information about the comment you just deleted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DeleteFile": { @@ -4628,6 +4735,9 @@ "smithy.api#documentation": "The email address for the commit that deletes the file. If no email address is\n specified, the email address is left blank.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeleteFileOutput": { @@ -4661,6 +4771,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DeletePullRequestApprovalRule": { @@ -4730,6 +4843,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeletePullRequestApprovalRuleOutput": { @@ -4738,10 +4854,13 @@ "approvalRuleId": { "target": "com.amazonaws.codecommit#ApprovalRuleId", "traits": { - "smithy.api#documentation": "The ID of the deleted approval rule.
\nIf the approval rule was deleted in an earlier API call, the response is 200 OK without\n content.
\nThe ID of the deleted approval rule.
\nIf the approval rule was deleted in an earlier API call, the response is 200 OK without\n content.
\nDeletes a repository. If a specified repository was already deleted, a null repository\n ID is returned.
\nDeleting a repository also deletes all associated objects and metadata. After a repository is\n deleted, all future push calls to the deleted repository fail.
\nDeletes a repository. If a specified repository was already deleted, a null repository\n ID is returned.
\nDeleting a repository also deletes all associated objects and metadata. After a repository is\n deleted, all future push calls to the deleted repository fail.
\nRepresents the input of a delete repository operation.
" + "smithy.api#documentation": "Represents the input of a delete repository operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DeleteRepositoryOutput": { @@ -4805,7 +4925,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a delete repository operation.
" + "smithy.api#documentation": "Represents the output of a delete repository operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DescribeMergeConflicts": { @@ -4958,6 +5079,9 @@ "smithy.api#documentation": "An enumeration token that, when provided in a request, returns the next batch of the\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DescribeMergeConflictsOutput": { @@ -5003,6 +5127,9 @@ "smithy.api#documentation": "The commit ID of the merge base.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#DescribePullRequestEvents": { @@ -5097,6 +5224,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results. \n The default is 100 events, which is also the maximum number of events that can be returned in a result.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#DescribePullRequestEventsOutput": { @@ -5115,6 +5245,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#Description": { @@ -5237,6 +5370,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#Email": { @@ -5387,6 +5523,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#EvaluatePullRequestApprovalRulesOutput": { @@ -5399,6 +5538,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#Evaluation": { @@ -5605,22 +5747,26 @@ } }, "com.amazonaws.codecommit#FileModeTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EXECUTABLE", - "name": "EXECUTABLE" - }, - { - "value": "NORMAL", - "name": "NORMAL" - }, - { - "value": "SYMLINK", - "name": "SYMLINK" + "type": "enum", + "members": { + "EXECUTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTABLE" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" } - ] + }, + "SYMLINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYMLINK" + } + } } }, "com.amazonaws.codecommit#FileModes": { @@ -5731,10 +5877,39 @@ } }, "traits": { - "smithy.api#documentation": "The specified file exceeds the file size limit for AWS CodeCommit. For more information about limits in AWS CodeCommit, see\n AWS CodeCommit User Guide.
", + "smithy.api#documentation": "The specified file exceeds the file size limit for CodeCommit. For more information about limits in CodeCommit, see\n Quotas in the CodeCommit User Guide.
", "smithy.api#error": "client" } }, + "com.amazonaws.codecommit#FileVersion": { + "type": "structure", + "members": { + "commit": { + "target": "com.amazonaws.codecommit#Commit" + }, + "blobId": { + "target": "com.amazonaws.codecommit#ObjectId", + "traits": { + "smithy.api#documentation": "The blob ID of the object that represents the content of the file in this version.
" + } + }, + "path": { + "target": "com.amazonaws.codecommit#Path", + "traits": { + "smithy.api#documentation": "The name and path of the file at which this blob is indexed which contains the data for this version of the file. This value will \n vary between file versions if a file is renamed or if its path changes.
" + } + }, + "revisionChildren": { + "target": "com.amazonaws.codecommit#RevisionChildren", + "traits": { + "smithy.api#documentation": "An array of commit IDs that contain more recent versions of this file. If there are no additional versions of the file, this array will be empty.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a version of a file.
" + } + }, "com.amazonaws.codecommit#FilesMetadata": { "type": "list", "member": { @@ -5836,6 +6011,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetApprovalRuleTemplateOutput": { @@ -5848,6 +6026,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetBlob": { @@ -5919,7 +6100,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a get blob operation.
" + "smithy.api#documentation": "Represents the input of a get blob operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetBlobOutput": { @@ -5934,7 +6116,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a get blob operation.
" + "smithy.api#documentation": "Represents the output of a get blob operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetBranch": { @@ -6001,7 +6184,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a get branch operation.
" + "smithy.api#documentation": "Represents the input of a get branch operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetBranchOutput": { @@ -6015,7 +6199,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a get branch operation.
" + "smithy.api#documentation": "Represents the output of a get branch operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetComment": { @@ -6056,7 +6241,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the content of a comment made on a change, file, or commit in a repository.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nReturns the content of a comment made on a change, file, or commit in a repository.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nThe contents of the comment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetCommentReactions": { @@ -6150,6 +6341,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetCommentReactionsOutput": { @@ -6168,6 +6362,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetCommentsForComparedCommit": { @@ -6220,7 +6417,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about comments made on the comparison between two commits.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nReturns information about comments made on the comparison between two commits.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nA non-zero, non-negative integer used to limit the number of returned results. The\n default is 100 comments, but you can configure up to 500.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetCommentsForComparedCommitOutput": { @@ -6280,6 +6480,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetCommentsForPullRequest": { @@ -6344,7 +6547,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns comments made on a pull request.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nReturns comments made on a pull request.
\nReaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of \n reactions from active identities, use GetCommentReactions.
\nThe name of the repository that contains the pull request.
" + "smithy.api#documentation": "The name of the repository that contains the pull request. Requirement is conditional: repositoryName must be specified when \n beforeCommitId and afterCommitId are included.
The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.
" + "smithy.api#documentation": "The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created. Requirement is conditional: \n beforeCommitId must be specified when repositoryName is included.
The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.
" + "smithy.api#documentation": "The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made. Requirement is conditional: \n afterCommitId must be specified when repositoryName is included.
A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments.\n You can return up to 500 comments with a single request.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetCommentsForPullRequestOutput": { @@ -6409,6 +6615,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetCommit": { @@ -6477,7 +6686,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a get commit operation.
" + "smithy.api#documentation": "Represents the input of a get commit operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetCommitOutput": { @@ -6492,7 +6702,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a get commit operation.
" + "smithy.api#documentation": "Represents the output of a get commit operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetDifferences": { @@ -6609,6 +6820,9 @@ "smithy.api#documentation": "An enumeration token that, when provided in a request, returns the next batch of the\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetDifferencesOutput": { @@ -6626,6 +6840,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetFile": { @@ -6697,7 +6914,7 @@ "commitSpecifier": { "target": "com.amazonaws.codecommit#CommitName", "traits": { - "smithy.api#documentation": "The fully quaified reference that identifies the commit that contains the file. For\n example, you can specify a full commit ID, a tag, a branch name, or a reference such as\n refs/heads/master. If none is provided, the head commit is used.
" + "smithy.api#documentation": "The fully quaified reference that identifies the commit that contains the file. For\n example, you can specify a full commit ID, a tag, a branch name, or a reference such as\n refs/heads/main. If none is provided, the head commit is used.
" } }, "filePath": { @@ -6707,6 +6924,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetFileOutput": { @@ -6736,7 +6956,7 @@ "fileMode": { "target": "com.amazonaws.codecommit#FileModeTypeEnum", "traits": { - "smithy.api#documentation": "The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values.
\nThe file mode permissions returned by this API are not the standard file mode\n permission values, such as 100644, but rather extrapolated values. See the supported\n return values.
\nThe extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values.
\nThe file mode permissions returned by this API are not the standard file mode\n permission values, such as 100644, but rather extrapolated values. See the supported\n return values.
\nThe list of submodules in the specified folder, if any.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetMergeCommit": { @@ -6973,6 +7202,9 @@ "smithy.api#documentation": "Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetMergeCommitOutput": { @@ -7002,6 +7234,9 @@ "smithy.api#documentation": "The commit ID for the merge commit created when the source branch was merged into the\n destination branch. If the fast-forward merge strategy was used, there is no merge\n commit.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetMergeConflicts": { @@ -7144,6 +7379,9 @@ "smithy.api#documentation": "An enumeration token that, when provided in a request, returns the next batch of the\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetMergeConflictsOutput": { @@ -7190,6 +7428,9 @@ "smithy.api#documentation": "An enumeration token that can be used in a request to return the next batch of the results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetMergeOptions": { @@ -7290,6 +7531,9 @@ "smithy.api#documentation": "Specifies which branch to use when resolving conflicts, or whether to attempt\n automatically merging two versions of a file. The default is NONE, which requires any\n conflicts to be resolved manually before the merge operation is successful.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetMergeOptionsOutput": { @@ -7323,6 +7567,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetPullRequest": { @@ -7424,6 +7671,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetPullRequestApprovalStatesOutput": { @@ -7435,6 +7685,9 @@ "smithy.api#documentation": "Information about users who have approved the pull request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetPullRequestInput": { @@ -7447,6 +7700,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetPullRequestOutput": { @@ -7459,6 +7715,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetPullRequestOverrideState": { @@ -7522,6 +7781,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetPullRequestOverrideStateOutput": { @@ -7540,6 +7802,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the pull request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetRepository": { @@ -7577,7 +7842,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a repository.
\n\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nReturns information about a repository.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nRepresents the input of a get repository operation.
" + "smithy.api#documentation": "Represents the input of a get repository operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetRepositoryOutput": { @@ -7606,7 +7872,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a get repository operation.
" + "smithy.api#documentation": "Represents the output of a get repository operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#GetRepositoryTriggers": { @@ -7659,7 +7926,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a get repository triggers operation.
" + "smithy.api#documentation": "Represents the input of a get repository triggers operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#GetRepositoryTriggersOutput": { @@ -7679,7 +7947,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a get repository triggers operation.
" + "smithy.api#documentation": "Represents the output of a get repository triggers operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#HunkContent": { @@ -7771,7 +8040,7 @@ } }, "traits": { - "smithy.api#documentation": "The description for the approval rule template is not valid because it exceeds the\n maximum characters allowed for a description. For more information about limits in AWS\n CodeCommit, see AWS CodeCommit User\n Guide.
", + "smithy.api#documentation": "The description for the approval rule template is not valid because it exceeds the\n maximum characters allowed for a description. For more information about limits in CodeCommit, \n see Quotas in the CodeCommit User Guide.
", "smithy.api#error": "client" } }, @@ -7786,7 +8055,7 @@ } }, "traits": { - "smithy.api#documentation": "The name of the approval rule template is not valid. Template names must be between 1\n and 100 valid characters in length. For more information about limits in AWS CodeCommit,\n see AWS\n CodeCommit User Guide.
", + "smithy.api#documentation": "The name of the approval rule template is not valid. Template names must be between 1\n and 100 valid characters in length. For more information about limits in CodeCommit,\n see Quotas in the CodeCommit User Guide.
", "smithy.api#error": "client" } }, @@ -8281,7 +8550,7 @@ } }, "traits": { - "smithy.api#documentation": "The value of the reaction is not valid. For more information, see the AWS CodeCommit User Guide.
", + "smithy.api#documentation": "The value of the reaction is not valid. For more information, see the CodeCommit User Guide.
", "smithy.api#error": "client" } }, @@ -8296,7 +8565,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified reference name format is not valid. Reference names must conform to the\n Git references format (for example, refs/heads/master). For more information, see Git Internals -\n Git References or consult your Git documentation.
", + "smithy.api#documentation": "The specified reference name format is not valid. Reference names must conform to the\n Git references format (for example, refs/heads/main). For more information, see Git Internals -\n Git References or consult your Git documentation.
", "smithy.api#error": "client" } }, @@ -8371,7 +8640,7 @@ } }, "traits": { - "smithy.api#documentation": "A specified repository name is not valid.
\n\nThis exception occurs only when a specified repository name is not valid. Other\n exceptions occur when a required repository parameter is missing, or when a\n specified repository does not exist.
\nA specified repository name is not valid.
\nThis exception occurs only when a specified repository name is not valid. Other\n exceptions occur when a required repository parameter is missing, or when a\n specified repository does not exist.
\nThe AWS Region for the trigger target does not match the AWS Region for the\n repository. Triggers must be created in the same Region as the target for the\n trigger.
", + "smithy.api#documentation": "The Amazon Web Services Region for the trigger target does not match the Amazon Web Services Region for the\n repository. Triggers must be created in the same Amazon Web Services Region as the target for the\n trigger.
", "smithy.api#error": "client" } }, @@ -8476,7 +8745,7 @@ } }, "traits": { - "smithy.api#documentation": "The value for the resource ARN is not valid. For more information about resources in AWS CodeCommit, see \n CodeCommit Resources and Operations\n in the AWS CodeCommit User Guide.
", + "smithy.api#documentation": "The value for the resource ARN is not valid. For more information about resources in CodeCommit, see \n CodeCommit Resources and Operations\n in the CodeCommit User Guide.
", "smithy.api#error": "client" } }, @@ -8751,7 +9020,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all approval rule templates in the specified AWS Region in your AWS account. If\n an AWS Region is not specified, the AWS Region where you are signed in is used.
", + "smithy.api#documentation": "Lists all approval rule templates in the specified Amazon Web Services Region in your Amazon Web Services account. If\n an Amazon Web Services Region is not specified, the Amazon Web Services Region where you are signed in is used.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -8774,6 +9043,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListApprovalRuleTemplatesOutput": { @@ -8782,7 +9054,7 @@ "approvalRuleTemplateNames": { "target": "com.amazonaws.codecommit#ApprovalRuleTemplateNameList", "traits": { - "smithy.api#documentation": "The names of all the approval rule templates found in the AWS Region for your AWS account.
" + "smithy.api#documentation": "The names of all the approval rule templates found in the Amazon Web Services Region for your Amazon Web Services account.
" } }, "nextToken": { @@ -8791,6 +9063,9 @@ "smithy.api#documentation": "An enumeration token that allows the operation to batch the next results of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListAssociatedApprovalRuleTemplatesForRepository": { @@ -8864,6 +9139,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListAssociatedApprovalRuleTemplatesForRepositoryOutput": { @@ -8881,6 +9159,9 @@ "smithy.api#documentation": "An enumeration token that allows the operation to batch the next results of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListBranches": { @@ -8947,27 +9228,151 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a list branches operation.
" + "smithy.api#documentation": "Represents the input of a list branches operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.codecommit#ListBranchesOutput": { + "type": "structure", + "members": { + "branches": { + "target": "com.amazonaws.codecommit#BranchNameList", + "traits": { + "smithy.api#documentation": "The list of branch names.
" + } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "An enumeration token that returns the batch of the results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the output of a list branches operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.codecommit#ListFileCommitHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.codecommit#ListFileCommitHistoryRequest" + }, + "output": { + "target": "com.amazonaws.codecommit#ListFileCommitHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codecommit#CommitDoesNotExistException" + }, + { + "target": "com.amazonaws.codecommit#CommitRequiredException" + }, + { + "target": "com.amazonaws.codecommit#EncryptionIntegrityChecksFailedException" + }, + { + "target": "com.amazonaws.codecommit#EncryptionKeyAccessDeniedException" + }, + { + "target": "com.amazonaws.codecommit#EncryptionKeyDisabledException" + }, + { + "target": "com.amazonaws.codecommit#EncryptionKeyNotFoundException" + }, + { + "target": "com.amazonaws.codecommit#EncryptionKeyUnavailableException" + }, + { + "target": "com.amazonaws.codecommit#InvalidCommitException" + }, + { + "target": "com.amazonaws.codecommit#InvalidContinuationTokenException" + }, + { + "target": "com.amazonaws.codecommit#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.codecommit#InvalidRepositoryNameException" + }, + { + "target": "com.amazonaws.codecommit#RepositoryDoesNotExistException" + }, + { + "target": "com.amazonaws.codecommit#RepositoryNameRequiredException" + }, + { + "target": "com.amazonaws.codecommit#TipsDivergenceExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of commits and changes to a specified file.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.codecommit#ListFileCommitHistoryRequest": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.codecommit#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository that contains the file.
", + "smithy.api#required": {} + } + }, + "commitSpecifier": { + "target": "com.amazonaws.codecommit#CommitName", + "traits": { + "smithy.api#documentation": "The fully quaified reference that identifies the commit that contains the file. For\n example, you can specify a full commit ID, a tag, a branch name, or a reference such as\n refs/heads/main. If none is provided, the head commit is used.
The full path of the file whose history you want to retrieve, including the name of the file.
", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.codecommit#Limit", + "traits": { + "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.codecommit#NextToken", + "traits": { + "smithy.api#documentation": "An enumeration token that allows the operation to batch the results.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.codecommit#ListBranchesOutput": { + "com.amazonaws.codecommit#ListFileCommitHistoryResponse": { "type": "structure", "members": { - "branches": { - "target": "com.amazonaws.codecommit#BranchNameList", + "revisionDag": { + "target": "com.amazonaws.codecommit#RevisionDag", "traits": { - "smithy.api#documentation": "The list of branch names.
" + "smithy.api#documentation": "An array of FileVersion objects that form a directed acyclic graph (DAG) of the changes to the file made by the commits that changed the file.
", + "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { - "smithy.api#documentation": "An enumeration token that returns the batch of the results.
" + "smithy.api#documentation": "An enumeration token that can be used to return the next batch of results.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a list branches operation.
" + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListPullRequests": { @@ -9062,6 +9467,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListPullRequestsOutput": { @@ -9080,6 +9488,9 @@ "smithy.api#documentation": "An enumeration token that allows the operation to batch the next results of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListRepositories": { @@ -9181,6 +9592,9 @@ "smithy.api#documentation": "A non-zero, non-negative integer used to limit the number of returned results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListRepositoriesForApprovalRuleTemplateOutput": { @@ -9198,6 +9612,9 @@ "smithy.api#documentation": "An enumeration token that allows the operation to batch the next results of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListRepositoriesInput": { @@ -9206,7 +9623,7 @@ "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { - "smithy.api#documentation": "An enumeration token that allows the operation to batch the results of the operation. \n Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit,\n another page of 1,000 records is retrieved.
" + "smithy.api#documentation": "An enumeration token that allows the operation to batch the results of the operation. \n Batch sizes are 1,000 for list repository operations. When the client sends the token back to CodeCommit,\n another page of 1,000 records is retrieved.
" } }, "sortBy": { @@ -9223,7 +9640,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a list repositories operation.
" + "smithy.api#documentation": "Represents the input of a list repositories operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListRepositoriesOutput": { @@ -9238,12 +9656,13 @@ "nextToken": { "target": "com.amazonaws.codecommit#NextToken", "traits": { - "smithy.api#documentation": "An enumeration token that allows the operation to batch the results of the operation. \n Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, \n another page of 1,000 records is retrieved.
" + "smithy.api#documentation": "An enumeration token that allows the operation to batch the results of the operation. \n Batch sizes are 1,000 for list repository operations. When the client sends the token back to CodeCommit, \n another page of 1,000 records is retrieved.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a list repositories operation.
" + "smithy.api#documentation": "Represents the output of a list repositories operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ListTagsForResource": { @@ -9269,7 +9688,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS\n CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User\n Guide.
" + "smithy.api#documentation": "Gets information about Amazon Web Servicestags for a specified Amazon Resource Name (ARN) in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User\n Guide.
" } }, "com.amazonaws.codecommit#ListTagsForResourceInput": { @@ -9288,6 +9707,9 @@ "smithy.api#documentation": "An enumeration token that, when provided in a request, returns the next batch of the\n results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#ListTagsForResourceOutput": { @@ -9305,6 +9727,9 @@ "smithy.api#documentation": "An enumeration token that allows the operation to batch the next results of the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#Location": { @@ -9602,6 +10027,9 @@ "smithy.api#documentation": "The branch where the merge is applied.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergeBranchesByFastForwardOutput": { @@ -9619,6 +10047,9 @@ "smithy.api#documentation": "The tree ID of the merge in the destination or target branch.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#MergeBranchesBySquash": { @@ -9825,6 +10256,9 @@ "smithy.api#documentation": "If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergeBranchesBySquashOutput": { @@ -9842,6 +10276,9 @@ "smithy.api#documentation": "The tree ID of the merge in the destination or target branch.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#MergeBranchesByThreeWay": { @@ -10048,6 +10485,9 @@ "smithy.api#documentation": "If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergeBranchesByThreeWayOutput": { @@ -10065,6 +10505,9 @@ "smithy.api#documentation": "The tree ID of the merge in the destination or target branch.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#MergeHunk": { @@ -10201,22 +10644,26 @@ } }, "com.amazonaws.codecommit#MergeOptionTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FAST_FORWARD_MERGE", - "name": "FAST_FORWARD_MERGE" - }, - { - "value": "SQUASH_MERGE", - "name": "SQUASH_MERGE" - }, - { - "value": "THREE_WAY_MERGE", - "name": "THREE_WAY_MERGE" + "type": "enum", + "members": { + "FAST_FORWARD_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAST_FORWARD_MERGE" + } + }, + "SQUASH_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQUASH_MERGE" + } + }, + "THREE_WAY_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_WAY_MERGE" } - ] + } } }, "com.amazonaws.codecommit#MergeOptions": { @@ -10319,6 +10766,9 @@ "smithy.api#documentation": "The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an \n exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergePullRequestByFastForwardOutput": { @@ -10330,6 +10780,9 @@ "smithy.api#documentation": "Information about the specified pull request, including the merge.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#MergePullRequestBySquash": { @@ -10526,6 +10979,9 @@ "smithy.api#documentation": "If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergePullRequestBySquashOutput": { @@ -10534,6 +10990,9 @@ "pullRequest": { "target": "com.amazonaws.codecommit#PullRequest" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#MergePullRequestByThreeWay": { @@ -10730,6 +11189,9 @@ "smithy.api#documentation": "If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when\n resolving conflicts during a merge.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#MergePullRequestByThreeWayOutput": { @@ -10738,6 +11200,9 @@ "pullRequest": { "target": "com.amazonaws.codecommit#PullRequest" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#Message": { @@ -10829,7 +11294,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of approval rule templates has been exceeded for this AWS Region.
", + "smithy.api#documentation": "The maximum number of approval rule templates has been exceeded for this Amazon Web Services Region.
", "smithy.api#error": "client" } }, @@ -10858,26 +11323,32 @@ } }, "com.amazonaws.codecommit#ObjectTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FILE", - "name": "FILE" - }, - { - "value": "DIRECTORY", - "name": "DIRECTORY" - }, - { - "value": "GIT_LINK", - "name": "GIT_LINK" - }, - { - "value": "SYMBOLIC_LINK", - "name": "SYMBOLIC_LINK" + "type": "enum", + "members": { + "FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE" } - ] + }, + "DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY" + } + }, + "GIT_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GIT_LINK" + } + }, + "SYMBOLIC_LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYMBOLIC_LINK" + } + } } }, "com.amazonaws.codecommit#ObjectTypes": { @@ -10907,18 +11378,20 @@ } }, "com.amazonaws.codecommit#OrderEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ascending", - "name": "ASCENDING" - }, - { - "value": "descending", - "name": "DESCENDING" + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "descending" } - ] + } } }, "com.amazonaws.codecommit#OriginApprovalRuleTemplate": { @@ -11045,21 +11518,26 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#OverrideStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OVERRIDE", - "name": "OVERRIDE" - }, - { - "value": "REVOKE", - "name": "REVOKE" + "type": "enum", + "members": { + "OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE" + } + }, + "REVOKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKE" } - ] + } } }, "com.amazonaws.codecommit#OverrideStatusRequiredException": { @@ -11291,6 +11769,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PostCommentForComparedCommitOutput": { @@ -11338,6 +11819,9 @@ "smithy.api#documentation": "The content of the comment you posted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#PostCommentForPullRequest": { @@ -11487,6 +11971,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PostCommentForPullRequestOutput": { @@ -11540,6 +12027,9 @@ "smithy.api#documentation": "The content of the comment you posted.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#PostCommentReply": { @@ -11605,6 +12095,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PostCommentReplyOutput": { @@ -11616,6 +12109,9 @@ "smithy.api#documentation": "Information about the reply to a comment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#PullRequest": { @@ -11865,46 +12361,62 @@ } }, "com.amazonaws.codecommit#PullRequestEventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PULL_REQUEST_CREATED", - "name": "PULL_REQUEST_CREATED" - }, - { - "value": "PULL_REQUEST_STATUS_CHANGED", - "name": "PULL_REQUEST_STATUS_CHANGED" - }, - { - "value": "PULL_REQUEST_SOURCE_REFERENCE_UPDATED", - "name": "PULL_REQUEST_SOURCE_REFERENCE_UPDATED" - }, - { - "value": "PULL_REQUEST_MERGE_STATE_CHANGED", - "name": "PULL_REQUEST_MERGE_STATE_CHANGED" - }, - { - "value": "PULL_REQUEST_APPROVAL_RULE_CREATED", - "name": "PULL_REQUEST_APPROVAL_RULE_CREATED" - }, - { - "value": "PULL_REQUEST_APPROVAL_RULE_UPDATED", - "name": "PULL_REQUEST_APPROVAL_RULE_UPDATED" - }, - { - "value": "PULL_REQUEST_APPROVAL_RULE_DELETED", - "name": "PULL_REQUEST_APPROVAL_RULE_DELETED" - }, - { - "value": "PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN", - "name": "PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN" - }, - { - "value": "PULL_REQUEST_APPROVAL_STATE_CHANGED", - "name": "PULL_REQUEST_APPROVAL_STATE_CHANGED" + "type": "enum", + "members": { + "PULL_REQUEST_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_CREATED" + } + }, + "PULL_REQUEST_STATUS_CHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_STATUS_CHANGED" + } + }, + "PULL_REQUEST_SOURCE_REFERENCE_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_SOURCE_REFERENCE_UPDATED" + } + }, + "PULL_REQUEST_MERGE_STATE_CHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_MERGE_STATE_CHANGED" + } + }, + "PULL_REQUEST_APPROVAL_RULE_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_APPROVAL_RULE_CREATED" + } + }, + "PULL_REQUEST_APPROVAL_RULE_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_APPROVAL_RULE_UPDATED" + } + }, + "PULL_REQUEST_APPROVAL_RULE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_APPROVAL_RULE_DELETED" } - ] + }, + "PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN" + } + }, + "PULL_REQUEST_APPROVAL_STATE_CHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PULL_REQUEST_APPROVAL_STATE_CHANGED" + } + } } }, "com.amazonaws.codecommit#PullRequestId": { @@ -12004,18 +12516,20 @@ } }, "com.amazonaws.codecommit#PullRequestStatusEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OPEN", - "name": "OPEN" - }, - { - "value": "CLOSED", - "name": "CLOSED" + "type": "enum", + "members": { + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN" } - ] + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } } }, "com.amazonaws.codecommit#PullRequestStatusRequiredException": { @@ -12137,10 +12651,13 @@ "reactionValue": { "target": "com.amazonaws.codecommit#ReactionValue", "traits": { - "smithy.api#documentation": "The emoji reaction you want to add or update. To remove a reaction, provide a value of blank or null. You can also provide the value of none.\n For information about emoji reaction values supported in AWS CodeCommit, see the AWS CodeCommit User Guide.
", + "smithy.api#documentation": "The emoji reaction you want to add or update. To remove a reaction, provide a value of blank or null. You can also provide the value of none.\n For information about emoji reaction values supported in CodeCommit, see the CodeCommit User Guide.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PutFile": { @@ -12244,7 +12761,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.
" + "smithy.api#documentation": "Adds or updates a file in a branch in an CodeCommit repository, and generates a commit for the addition in the specified branch.
" } }, "com.amazonaws.codecommit#PutFileEntries": { @@ -12328,7 +12845,7 @@ "filePath": { "target": "com.amazonaws.codecommit#Path", "traits": { - "smithy.api#documentation": "The name of the file you want to add or update, including the relative path to the file in the repository.
\nIf the path does not currently exist in the repository, the path is created as part of adding\n the file.
\nThe name of the file you want to add or update, including the relative path to the file in the repository.
\nIf the path does not currently exist in the repository, the path is created as part of adding\n the file.
\nThe full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, \n no commit ID is required. If this is not an empty repository, a commit ID is required.
\nThe commit ID must match the ID of the head commit at the time of the operation.\n Otherwise, an error occurs, and the file is not added or updated.
" + "smithy.api#documentation": "The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, \n no commit ID is required. If this is not an empty repository, a commit ID is required.
\nThe commit ID must match the ID of the head commit at the time of the operation.\n Otherwise, an error occurs, and the file is not added or updated.
" } }, "commitMessage": { @@ -12362,6 +12879,9 @@ "smithy.api#documentation": "An email address for the person adding or updating the file.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PutFileOutput": { @@ -12388,6 +12908,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#PutRepositoryTriggers": { @@ -12486,7 +13009,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a put repository triggers operation.
" + "smithy.api#documentation": "Represents the input of a put repository triggers operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#PutRepositoryTriggersOutput": { @@ -12500,7 +13024,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a put repository triggers operation.
" + "smithy.api#documentation": "Represents the output of a put repository triggers operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#ReactionCountsMap": { @@ -12594,7 +13119,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the values for reactions to a comment. AWS CodeCommit supports a limited set of reactions.
" + "smithy.api#documentation": "Information about the values for reactions to a comment. CodeCommit supports a limited set of reactions.
" } }, "com.amazonaws.codecommit#ReactionValueRequiredException": { @@ -12667,18 +13192,20 @@ } }, "com.amazonaws.codecommit#RelativeFileVersionEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BEFORE", - "name": "BEFORE" - }, - { - "value": "AFTER", - "name": "AFTER" + "type": "enum", + "members": { + "BEFORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE" + } + }, + "AFTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER" } - ] + } } }, "com.amazonaws.codecommit#ReplaceContentEntries": { @@ -12737,26 +13264,32 @@ } }, "com.amazonaws.codecommit#ReplacementTypeEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "KEEP_BASE", - "name": "KEEP_BASE" - }, - { - "value": "KEEP_SOURCE", - "name": "KEEP_SOURCE" - }, - { - "value": "KEEP_DESTINATION", - "name": "KEEP_DESTINATION" - }, - { - "value": "USE_NEW_CONTENT", - "name": "USE_NEW_CONTENT" + "type": "enum", + "members": { + "KEEP_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP_BASE" + } + }, + "KEEP_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP_SOURCE" + } + }, + "KEEP_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEEP_DESTINATION" } - ] + }, + "USE_NEW_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USE_NEW_CONTENT" + } + } } }, "com.amazonaws.codecommit#ReplacementTypeRequiredException": { @@ -12822,7 +13355,7 @@ "accountId": { "target": "com.amazonaws.codecommit#AccountId", "traits": { - "smithy.api#documentation": "The ID of the AWS account associated with the repository.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account associated with the repository.
" } }, "repositoryId": { @@ -12897,7 +13430,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "[\\w\\.-]+" + "smithy.api#pattern": "^[\\w\\.-]+$" } }, "com.amazonaws.codecommit#RepositoryNameExistsException": { @@ -13024,19 +13557,19 @@ "branches": { "target": "com.amazonaws.codecommit#BranchNameList", "traits": { - "smithy.api#documentation": "The branches to be included in the trigger configuration. If you specify an empty\n array, the trigger applies to all branches.
\nAlthough no content is required in the array, you must include the array itself.
\nThe branches to be included in the trigger configuration. If you specify an empty\n array, the trigger applies to all branches.
\nAlthough no content is required in the array, you must include the array itself.
\nThe repository events that cause the trigger to run actions in another service, such\n as sending a notification through Amazon SNS.\n \n
\nThe valid value \"all\" cannot be used with any other values.
\nThe repository events that cause the trigger to run actions in another service, such\n as sending a notification through Amazon SNS. \n \n
\nThe valid value \"all\" cannot be used with any other values.
\nInformation about a trigger for a repository.
" + "smithy.api#documentation": "Information about a trigger for a repository.
\nIf you want to receive notifications about repository events, consider using notifications instead of \n triggers. For more information, see Configuring\n notifications for repository events.
\nA valid Amazon Resource Name (ARN) for an AWS CodeCommit resource is required. For a list of valid resources in AWS CodeCommit, see \n CodeCommit Resources and Operations\n in the AWS CodeCommit User Guide.
", + "smithy.api#documentation": "A valid Amazon Resource Name (ARN) for an CodeCommit resource is required. For a list of valid resources in CodeCommit, see \n CodeCommit Resources and Operations\n in the CodeCommit User Guide.
", "smithy.api#error": "client" } }, @@ -13226,6 +13765,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codecommit#RevisionChildren": { + "type": "list", + "member": { + "target": "com.amazonaws.codecommit#RevisionId" + } + }, + "com.amazonaws.codecommit#RevisionDag": { + "type": "list", + "member": { + "target": "com.amazonaws.codecommit#FileVersion" + } + }, "com.amazonaws.codecommit#RevisionId": { "type": "string" }, @@ -13321,18 +13872,20 @@ } }, "com.amazonaws.codecommit#SortByEnum": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "repositoryName", - "name": "REPOSITORY_NAME" - }, - { - "value": "lastModifiedDate", - "name": "MODIFIED_DATE" + "type": "enum", + "members": { + "REPOSITORY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "repositoryName" + } + }, + "MODIFIED_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lastModifiedDate" } - ] + } } }, "com.amazonaws.codecommit#SourceAndDestinationAreSameException": { @@ -13540,7 +14093,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates tags for a resource in AWS CodeCommit. For a list of valid resources\n in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User\n Guide.
" + "smithy.api#documentation": "Adds or updates tags for a resource in CodeCommit. For a list of valid resources\n in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User\n Guide.
" } }, "com.amazonaws.codecommit#TagResourceInput": { @@ -13560,6 +14113,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#TagValue": { @@ -13755,7 +14311,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a test repository triggers operation.
" + "smithy.api#documentation": "Represents the input of a test repository triggers operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#TestRepositoryTriggersOutput": { @@ -13775,7 +14332,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of a test repository triggers operation.
" + "smithy.api#documentation": "Represents the output of a test repository triggers operation.
", + "smithy.api#output": {} } }, "com.amazonaws.codecommit#TipOfSourceReferenceIsDifferentException": { @@ -13843,7 +14401,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum number of tags for an AWS CodeCommit resource has been exceeded.
", + "smithy.api#documentation": "The maximum number of tags for an CodeCommit resource has been exceeded.
", "smithy.api#error": "client" } }, @@ -13885,7 +14443,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags for a resource in AWS CodeCommit. For a list of valid resources in AWS\n CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User\n Guide.
" + "smithy.api#documentation": "Removes tags for a resource in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User\n Guide.
" } }, "com.amazonaws.codecommit#UntagResourceInput": { @@ -13905,6 +14463,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateContent": { @@ -13962,6 +14523,9 @@ "smithy.api#documentation": "The SHA-256 hash signature for the content of the approval rule. You can retrieve this\n information by using\n GetPullRequest.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateContentOutput": { @@ -13973,6 +14537,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateDescription": { @@ -14018,6 +14585,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateDescriptionOutput": { @@ -14030,6 +14600,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateName": { @@ -14075,6 +14648,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateApprovalRuleTemplateNameOutput": { @@ -14087,6 +14663,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#UpdateComment": { @@ -14141,6 +14720,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateCommentOutput": { @@ -14152,6 +14734,9 @@ "smithy.api#documentation": "Information about the updated comment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codecommit#UpdateDefaultBranch": { @@ -14198,7 +14783,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets or changes the default branch name for the specified repository.
\nIf you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.
\nSets or changes the default branch name for the specified repository.
\nIf you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.
\nThe name of the repository to set or change the default branch for.
", + "smithy.api#documentation": "The name of the repository for which you want to set or change the default branch.
", "smithy.api#required": {} } }, "defaultBranchName": { "target": "com.amazonaws.codecommit#BranchName", "traits": { - "smithy.api#documentation": "The name of the branch to set as the default.
", + "smithy.api#documentation": "The name of the branch to set as the default branch.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of an update default branch operation.
" + "smithy.api#documentation": "Represents the input of an update default branch operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdatePullRequestApprovalRuleContent": { @@ -14311,10 +14897,13 @@ "newRuleContent": { "target": "com.amazonaws.codecommit#ApprovalRuleContent", "traits": { - "smithy.api#documentation": "The updated content for the approval rule.
\nWhen you update the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an AWS account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the AWS account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.
\n \nThe updated content for the approval rule.
\nWhen you update the content of the approval rule, you can specify approvers in an\n approval pool in one of two ways:
\n\n CodeCommitApprovers: This option only\n requires an Amazon Web Services account and a resource. It can be used for both IAM users\n and federated access users whose name matches the provided resource name.\n This is a very powerful option that offers a great deal of flexibility. For\n example, if you specify the Amazon Web Services account 123456789012\n and Mary_Major, all of the following are counted as\n approvals coming from that user:
\nAn IAM user in the account\n (arn:aws:iam::123456789012:user/Mary_Major)
\nA federated user identified in IAM as Mary_Major\n (arn:aws:sts::123456789012:federated-user/Mary_Major)
\nThis option does not recognize an active session of someone assuming the\n role of CodeCommitReview with a role session name of\n Mary_Major\n (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major)\n unless you include a wildcard (*Mary_Major).
\n\n Fully qualified ARN: This option allows\n you to specify the fully qualified Amazon Resource Name (ARN) of the IAM\n user or role.
\nFor more information about IAM ARNs, wildcards, and formats, see IAM\n Identifiers in the IAM User Guide.
\nSets or changes the comment or description for a repository.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nSets or changes the comment or description for a repository.
\nThe description field for a repository accepts all HTML characters and all valid\n Unicode characters. Applications that do not HTML-encode the description and display\n it in a webpage can expose users to potentially malicious code. Make sure that you\n HTML-encode the description field in any application that uses this API to display\n the repository description on a webpage.
\nRepresents the input of an update repository description operation.
" + "smithy.api#documentation": "Represents the input of an update repository description operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UpdateRepositoryName": { @@ -14703,7 +15317,7 @@ } ], "traits": { - "smithy.api#documentation": "Renames a repository. The repository name must be unique across the calling AWS\n account. Repository names are limited to 100 alphanumeric, dash, and underscore\n characters, and cannot include certain characters. The suffix .git is prohibited. For\n more information about the limits on repository names, see Limits in the AWS CodeCommit\n User Guide.
" + "smithy.api#documentation": "Renames a repository. The repository name must be unique across the calling Amazon Web Services account. \n Repository names are limited to 100 alphanumeric, dash, and underscore\n characters, and cannot include certain characters. The suffix .git is prohibited. For\n more information about the limits on repository names, see Quotas in the CodeCommit\n User Guide.
" } }, "com.amazonaws.codecommit#UpdateRepositoryNameInput": { @@ -14725,7 +15339,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of an update repository description operation.
" + "smithy.api#documentation": "Represents the input of an update repository description operation.
", + "smithy.api#input": {} } }, "com.amazonaws.codecommit#UserInfo": { diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 59ae2287968..7f95b7a2537 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -56,6 +56,16 @@ ], "traits": { "smithy.api#documentation": "Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.
\nThis operation is only used by member accounts that are not added through\n Organizations.
\nWhen the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.
", + "smithy.api#examples": [ + { + "title": "To accept an invitation be a member account", + "documentation": "The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.", + "input": { + "AdministratorId": "123456789012", + "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/administrator", @@ -17564,6 +17574,12 @@ "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the finding is a sample finding.
" } + }, + "GeneratorDetails": { + "target": "com.amazonaws.securityhub#GeneratorDetails", + "traits": { + "smithy.api#documentation": "Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to \nfindings that relate to Lambda functions. Amazon Inspector identifies policy violations and \nvulnerabilities in Lambda function code based on internal detectors developed \nin collaboration with Amazon CodeGuru. Security Hub receives those findings.\n
" + } } }, "traits": { @@ -19734,6 +19750,30 @@ ], "traits": { "smithy.api#documentation": "\n Deletes one or more automation rules.\n
", + "smithy.api#examples": [ + { + "title": "To delete one or more automation rules", + "documentation": "The following example deletes the specified automation rules.", + "input": { + "AutomationRulesArns": [ + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + ] + }, + "output": { + "ProcessedAutomationRules": [ + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + ], + "UnprocessedAutomationRules": [ + { + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "ErrorCode": 500, + "ErrorMessage": "InternalException" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/automationrules/delete", @@ -19800,6 +19840,27 @@ ], "traits": { "smithy.api#documentation": "Disables the standards specified by the provided\n StandardsSubscriptionArns.
For more information, see Security Standards section of the Security Hub User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To disable one or more security standards", + "documentation": "The following example disables a security standard in Security Hub.", + "input": { + "StandardsSubscriptionArns": [ + "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + ] + }, + "output": { + "StandardsSubscriptions": [ + { + "StandardsArn": "arn:aws:securityhub:eu-central-1::standards/pci-dss/v/3.2.1", + "StandardsInput": {}, + "StandardsStatus": "DELETING", + "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/standards/deregister", @@ -19860,6 +19921,29 @@ ], "traits": { "smithy.api#documentation": "Enables the standards specified by the provided StandardsArn. To obtain the\n ARN for a standard, use the DescribeStandards\n operation.
For more information, see the Security Standards\n section of the Security Hub User Guide.
", + "smithy.api#examples": [ + { + "title": "To enable security standards", + "documentation": "The following example enables the security standard specified by the StandardArn. You can use this operation to enable one or more Security Hub standards.", + "input": { + "StandardsSubscriptionRequests": [ + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1" + } + ] + }, + "output": { + "StandardsSubscriptions": [ + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1", + "StandardsInput": {}, + "StandardsStatus": "PENDING", + "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/standards/register", @@ -19926,6 +20010,98 @@ ], "traits": { "smithy.api#documentation": "\n Retrieves a list of details for automation rules based on rule Amazon Resource Names \n (ARNs).\n
", + "smithy.api#examples": [ + { + "title": "To update one ore more automation rules", + "documentation": "The following example updates the specified automation rules.", + "input": { + "AutomationRulesArns": [ + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + ] + }, + "output": { + "Rules": [ + { + "RuleName": "sample-rule-name-1", + "RuleOrder": 1, + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RuleStatus": "ENABLED", + "Description": "sample rule description 1", + "Criteria": { + "AwsAccountId": [ + { + "Value": "111122223333", + "Comparison": "EQUALS" + } + ], + "Type": [ + { + "Value": "Software and Configuration Checks/Industry and Regulatory Standards", + "Comparison": "EQUALS" + } + ], + "FirstObservedAt": [ + { + "DateRange": { + "Unit": "DAYS", + "Value": 5 + } + } + ] + }, + "Actions": [ + { + "Type": "FINDING_FIELDS_UPDATE", + "FindingFieldsUpdate": { + "Workflow": { + "Status": "RESOLVED" + } + } + } + ], + "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14", + "CreatedAt": "2022-08-31T01:52:33.250Z", + "UpdatedAt": "2022-08-31T01:52:33.250Z" + }, + { + "RuleName": "sample-rule-name-2", + "RuleOrder": 2, + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "RuleStatus": "ENABLED", + "Description": "Sample rule description 2", + "Criteria": { + "SeverityLabel": [ + { + "Value": "INFORMATIONAL", + "Comparison": "EQUALS" + } + ], + "ResourceType": [ + { + "Value": "Ec2Instance", + "Comparison": "EQUALS" + } + ] + }, + "Actions": [ + { + "Type": "FINDING_FIELDS_UPDATE", + "FindingFieldsUpdate": { + "Workflow": { + "Status": "RESOLVED" + } + } + } + ], + "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14", + "CreatedAt": "2022-08-31T01:52:33.250Z", + "UpdatedAt": "2022-08-31T01:52:33.250Z" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/automationrules/get", @@ -19992,6 +20168,40 @@ ], "traits": { "smithy.api#documentation": "\n Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.\n
", + "smithy.api#examples": [ + { + "title": "To get security control details ", + "documentation": "The following example gets details for the specified controls in the current AWS account and AWS Region.", + "input": { + "SecurityControlIds": [ + "ACM.1", + "APIGateway.1" + ] + }, + "output": { + "SecurityControls": [ + { + "SecurityControlId": "ACM.1", + "SecurityControlArn": "arn:aws:securityhub:us-west-2:123456789012:security-control/ACM.1", + "Title": "Imported and ACM-issued certificates should be renewed after a specified time period", + "Description": "This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation", + "SeverityRating": "MEDIUM", + "SecurityControlStatus": "ENABLED" + }, + { + "SecurityControlId": "APIGateway.1", + "SecurityControlArn": "arn:aws:securityhub:us-west-2:123456789012:security-control/APIGateway.1", + "Title": "API Gateway REST and WebSocket API execution logging should be enabled", + "Description": "This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation", + "SeverityRating": "MEDIUM", + "SecurityControlStatus": "ENABLED" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/securityControls/batchGet", @@ -20126,6 +20336,49 @@ ], "traits": { "smithy.api#documentation": "Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.
\n\n BatchImportFindings must be called by one of the following:
The Amazon Web Services account that is associated with a finding if you are using\n the default product ARN \n or are a partner sending findings from within a customer's Amazon Web Services account. \n In these cases, the identifier of the account that you are calling BatchImportFindings \n from needs to be the same as the AwsAccountId attribute for the finding.
An Amazon Web Services account that Security Hub has allow-listed for an official partner\n integration. In this case, you can call BatchImportFindings from the allow-listed\n account and send findings from different customer accounts in the same batch.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.
\nAfter a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.
\n Note\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
Finding providers also should not use BatchImportFindings to update the following attributes.
\n Confidence\n
\n Criticality\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
Instead, finding providers use FindingProviderFields to provide values for these attributes.
\n Updates one or more automation rules based on rule Amazon Resource Names (ARNs) \n and input parameters.\n
", + "smithy.api#examples": [ + { + "title": "To update one ore more automation rules", + "documentation": "The following example updates the specified automation rules.", + "input": { + "UpdateAutomationRulesRequestItems": [ + { + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RuleStatus": "ENABLED", + "RuleOrder": 15 + }, + { + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "RuleStatus": "DISABLED" + } + ] + }, + "output": { + "ProcessedAutomationRules": [ + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + ] + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/automationrules/update", @@ -20283,6 +20561,62 @@ ], "traits": { "smithy.api#documentation": "Used by Security Hub customers to update information about their investigation into a finding.\n Requested by administrator accounts or member accounts. Administrator accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.
\nUpdates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.
Administrator and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.
\n Confidence\n
\n Criticality\n
\n Note\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n Security Hub User Guide.
", + "smithy.api#examples": [ + { + "title": "To update Security Hub findings", + "documentation": "The following example updates Security Hub findings. The finding identifier parameter specifies which findings to update. Only specific finding fields can be updated with this operation.", + "input": { + "FindingIdentifiers": [ + { + "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub" + }, + { + "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub" + } + ], + "Note": { + "Text": "Known issue that is not a risk.", + "UpdatedBy": "user1" + }, + "Severity": { + "Label": "LOW" + }, + "VerificationState": "TRUE_POSITIVE", + "Confidence": 80, + "Criticality": 80, + "Types": [ + "Software and Configuration Checks/Vulnerabilities/CVE" + ], + "UserDefinedFields": { + "reviewedByCio": "true" + }, + "Workflow": { + "Status": "RESOLVED" + }, + "RelatedFindings": [ + { + "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub" + } + ] + }, + "output": { + "ProcessedFindings": [ + { + "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub" + }, + { + "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub" + } + ], + "UnprocessedFindings": [] + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/findings/batchupdate", @@ -20439,6 +20773,42 @@ ], "traits": { "smithy.api#documentation": "\n For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.\n
", + "smithy.api#examples": [ + { + "title": "To update enablement status of a batch of controls", + "documentation": "The following example disables CloudWatch.12 in CIS AWS Foundations Benchmark v1.2.0. The example returns an error for CloudTrail.1 because an invalid standard ARN is provided.", + "input": { + "StandardsControlAssociationUpdates": [ + { + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0", + "AssociationStatus": "DISABLED", + "UpdatedReason": "Not relevant to environment" + }, + { + "SecurityControlId": "CloudWatch.12", + "StandardsArn": "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0", + "AssociationStatus": "DISABLED", + "UpdatedReason": "Not relevant to environment" + } + ] + }, + "output": { + "UnprocessedAssociationUpdates": [ + { + "ErrorCode": "INVALID_INPUT", + "ErrorReason": "Invalid Standards Arn: 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0'", + "StandardsControlAssociationUpdate": { + "AssociationStatus": "DISABLED", + "SecurityControlId": "CloudTrail.1", + "StandardsArn": "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0", + "UpdatedReason": "Test Reason" + } + } + ] + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/associations", @@ -20660,6 +21030,40 @@ "smithy.api#documentation": "Provides details about the current status of the sensitive data detection.
" } }, + "com.amazonaws.securityhub#CodeVulnerabilitiesFilePath": { + "type": "structure", + "members": { + "EndLine": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n \tThe line number of the last line of code in which the vulnerability is located.\n
" + } + }, + "FileName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the file in which the code vulnerability is located.\n
" + } + }, + "FilePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The file path to the code in which the vulnerability is located.\n
" + } + }, + "StartLine": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The line number of the first line of code in which the vulnerability is located.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides details about where a code vulnerability is located in your Lambda function.\n
" + } + }, "com.amazonaws.securityhub#Compliance": { "type": "structure", "members": { @@ -20859,6 +21263,20 @@ ], "traits": { "smithy.api#documentation": "Creates a custom action target in Security Hub.
\nYou can use custom actions on findings and insights in Security Hub to trigger target actions\n in Amazon CloudWatch Events.
", + "smithy.api#examples": [ + { + "title": "To create a custom action target", + "documentation": "The following example creates a custom action target in Security Hub. Custom actions on findings and insights automatically trigger actions in Amazon CloudWatch Events.", + "input": { + "Name": "Send to remediation", + "Description": "Action to send the finding for remediation tracking", + "Id": "Remediation" + }, + "output": { + "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/actionTargets", @@ -20937,6 +21355,71 @@ ], "traits": { "smithy.api#documentation": "\n Creates an automation rule based on input parameters.\n
", + "smithy.api#examples": [ + { + "title": "To create an automation rule", + "documentation": "The following example creates an automation rule.", + "input": { + "Tags": { + "important-resources-rule": "s3-bucket" + }, + "RuleStatus": "ENABLED", + "RuleOrder": 1, + "RuleName": "Elevate severity for important resources", + "Description": "Elevate finding severity to Critical for important resources", + "IsTerminal": false, + "Criteria": { + "ProductName": [ + { + "Value": "Security Hub", + "Comparison": "EQUALS" + } + ], + "ComplianceStatus": [ + { + "Value": "FAILED", + "Comparison": "EQUALS" + } + ], + "RecordState": [ + { + "Value": "ACTIVE", + "Comparison": "EQUALS" + } + ], + "WorkflowStatus": [ + { + "Value": "NEW", + "Comparison": "EQUALS" + } + ], + "ResourceId": [ + { + "Value": "arn:aws:s3:::examplebucket/developers/design_info.doc", + "Comparison": "EQUALS" + } + ] + }, + "Actions": [ + { + "Type": "FINDING_FIELDS_UPDATE", + "FindingFieldsUpdate": { + "Severity": { + "Label": "CRITICAL" + }, + "Note": { + "Text": "This is a critical S3 bucket, please look into this ASAP", + "UpdatedBy": "test-user" + } + } + } + ] + }, + "output": { + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/automationrules/create", @@ -21048,6 +21531,28 @@ ], "traits": { "smithy.api#documentation": "Used to enable finding aggregation. Must be called from the aggregation Region.
\nFor more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n
", + "smithy.api#examples": [ + { + "title": "To enable cross-Region aggregation", + "documentation": "The following example creates a finding aggregator. This is required to enable cross-Region aggregation.", + "input": { + "RegionLinkingMode": "SPECIFIED_REGIONS", + "Regions": [ + "us-west-1", + "us-west-2" + ] + }, + "output": { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "FindingAggregationRegion": "us-east-1", + "RegionLinkingMode": "SPECIFIED_REGIONS", + "Regions": [ + "us-west-1", + "us-west-2" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/findingAggregator/create", @@ -21135,6 +21640,33 @@ ], "traits": { "smithy.api#documentation": "Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate\n to a security issue that requires attention or remediation.
\nTo group the related findings in the insight, use the\n GroupByAttribute.
Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.
\n\n CreateMembers is always used to add accounts that are not organization\n members.
For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:
Security Hub is not configured to automatically add new organization accounts.
\nThe account was disassociated or deleted in Security Hub.
\nThis action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.
\nIf the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
\nFor organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
\nA permissions policy is added that permits the administrator account to view the findings\n generated in the member account.
\nTo remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Declines invitations to become a member account.
\nA prospective member account uses this operation to decline an invitation to become a member.
\nThis operation is only called by member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.
", + "smithy.api#examples": [ + { + "title": "To decline invitation to become a member account", + "documentation": "The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.", + "input": { + "AccountIds": [ + "123456789012", + "111122223333" + ] + }, + "output": { + "UnprocessedAccounts": [] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/invitations/decline", @@ -21532,6 +22098,18 @@ ], "traits": { "smithy.api#documentation": "Deletes a custom action target from Security Hub.
\nDeleting a custom action target does not affect any findings or insights that were\n already sent to Amazon CloudWatch Events using the custom action.
", + "smithy.api#examples": [ + { + "title": "To delete a custom action target", + "documentation": "The following example deletes a custom action target that triggers target actions in Amazon CloudWatch Events. Deleting a custom action target doesn't affect findings or insights that were already sent to CloudWatch Events based on the custom action.", + "input": { + "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation" + }, + "output": { + "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/actionTargets/{ActionTargetArn+}", @@ -21600,6 +22178,15 @@ ], "traits": { "smithy.api#documentation": "Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
\nWhen you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.\n
", + "smithy.api#examples": [ + { + "title": "To delete a finding aggregator", + "documentation": "The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.", + "input": { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/findingAggregator/delete/{FindingAggregatorArn+}", @@ -21657,6 +22244,18 @@ ], "traits": { "smithy.api#documentation": "Deletes the insight specified by the InsightArn.
Deletes invitations received by the Amazon Web Services account to become a member account.
\nA Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
\nThis operation is only used to delete invitations that are sent to member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.
", + "smithy.api#examples": [ + { + "title": "To delete a custom insight", + "documentation": "The following example deletes an invitation sent by the Security Hub administrator account to a prospective member account. This operation is used only for invitations sent to accounts that aren't part of an organization. Organization accounts don't receive invitations.", + "input": { + "AccountIds": [ + "123456789012" + ] + }, + "output": { + "UnprocessedAccounts": [] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/invitations/delete", @@ -21784,7 +22397,22 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified member accounts from Security Hub.
\nCan be used to delete member accounts that belong to an organization as well as member\n accounts that were invited manually.
", + "smithy.api#documentation": "Deletes the specified member accounts from Security Hub.
\nYou can invoke this API only to delete accounts that became members through invitation. You can't invoke this \n API to delete accounts that belong to an Organizations organization.
", + "smithy.api#examples": [ + { + "title": "To delete a member account", + "documentation": "The following example deletes the specified member account from Security Hub. This operation can be used to delete member accounts that are part of an organization or that were invited manually.", + "input": { + "AccountIds": [ + "123456789111", + "123456789222" + ] + }, + "output": { + "UnprocessedAccounts": [] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/members/delete", @@ -21845,6 +22473,26 @@ ], "traits": { "smithy.api#documentation": "Returns a list of the custom action targets in Security Hub in your account.
", + "smithy.api#examples": [ + { + "title": "To return custom action targets", + "documentation": "The following example returns a list of custom action targets. You use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.", + "input": { + "ActionTargetArns": [ + "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation" + ] + }, + "output": { + "ActionTargets": [ + { + "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation", + "Description": "Action to send the finding for remediation tracking", + "Name": "Send to remediation" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/actionTargets/get", @@ -21933,6 +22581,21 @@ ], "traits": { "smithy.api#documentation": "Returns details about the Hub resource in your account, including the\n HubArn and the time when you enabled Security Hub.
Returns information about the Organizations configuration for Security Hub. Can only be\n called from a Security Hub administrator account.
", + "smithy.api#examples": [ + { + "title": "To get information about Organizations configuration", + "documentation": "The following example returns details about the way in which AWS Organizations is configured for a Security Hub account that belongs to an organization. Only a Security Hub administrator account can call this operation.", + "output": { + "AutoEnable": true, + "MemberAccountLimitReached": true, + "AutoEnableStandards": "DEFAULT" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/organization/configuration", @@ -22078,6 +22752,41 @@ ], "traits": { "smithy.api#documentation": "Returns information about product integrations in Security Hub.
\nYou can optionally provide an integration ARN. If you provide an integration ARN, then\n the results only include that integration.
\nIf you do not provide an integration ARN, then the results include all of the available\n product integrations.
", + "smithy.api#examples": [ + { + "title": "To get information about Security Hub integrations", + "documentation": "The following example returns details about AWS services and third-party products that Security Hub integrates with.", + "input": { + "NextToken": "NULL", + "MaxResults": 1, + "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon" + }, + "output": { + "Products": [ + { + "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon", + "ProductName": "CrowdStrike Falcon", + "CompanyName": "CrowdStrike", + "Description": "CrowdStrike Falcon's single lightweight sensor unifies next-gen antivirus, endpoint detection and response, and 24/7 managed hunting, via the cloud.", + "Categories": [ + "Endpoint Detection and Response (EDR)", + "AV Scanning and Sandboxing", + "Threat Intelligence Feeds and Reports", + "Endpoint Forensics", + "Network Forensics" + ], + "IntegrationTypes": [ + "SEND_FINDINGS_TO_SECURITY_HUB" + ], + "MarketplaceUrl": "https://aws.amazon.com/marketplace/seller-profile?id=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ActivationUrl": "https://falcon.crowdstrike.com/support/documentation", + "ProductSubscriptionResourcePolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"123456789333\"},\"Action\":[\"securityhub:BatchImportFindings\"],\"Resource\":\"arn:aws:securityhub:us-west-1:123456789012:product-subscription/crowdstrike/crowdstrike-falcon\",\"Condition\":{\"StringEquals\":{\"securityhub:TargetAccount\":\"123456789012\"}}},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"123456789012\"},\"Action\":[\"securityhub:BatchImportFindings\"],\"Resource\":\"arn:aws:securityhub:us-west-1:123456789333:product/crowdstrike/crowdstrike-falcon\",\"Condition\":{\"StringEquals\":{\"securityhub:TargetAccount\":\"123456789012\"}}}]}" + } + ], + "NextToken": "U2FsdGVkX18vvPlOqb7RDrWRWVFBJI46MOIAb+nZmRJmR15NoRi2gm13sdQEn3O/pq/78dGs+bKpgA+7HMPHO0qX33/zoRI+uIG/F9yLNhcOrOWzFUdy36JcXLQji3Rpnn/cD1SVkGA98qI3zPOSDg==" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/products", @@ -22163,6 +22872,40 @@ ], "traits": { "smithy.api#documentation": "Returns a list of the available standards in Security Hub.
\nFor each standard, the results include the standard ARN, the name, and a description.
", + "smithy.api#examples": [ + { + "title": "To get available Security Hub standards", + "documentation": "The following example returns a list of available security standards in Security Hub.", + "output": { + "Standards": [ + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "Name": "AWS Foundational Security Best Practices v1.0.0", + "Description": "The AWS Foundational Security Best Practices standard is a set of automated security checks that detect when AWS accounts and deployed resources do not align to security best practices. The standard is defined by AWS security experts. This curated set of controls helps improve your security posture in AWS, and cover AWS's most popular and foundational services.", + "EnabledByDefault": true + }, + { + "StandardsArn": "arn:aws:securityhub:us-west-1::ruleset/cis-aws-foundations-benchmark/v/1.2.0", + "Name": "CIS AWS Foundations Benchmark v1.2.0", + "Description": "The Center for Internet Security (CIS) AWS Foundations Benchmark v1.2.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.", + "EnabledByDefault": true + }, + { + "StandardsArn": "arn:aws::securityhub:us-west-1::standards/cis-aws-foundations-benchmark/v/1.4.0", + "Name": "CIS AWS Foundations Benchmark v1.4.0", + "Description": "The Center for Internet Security (CIS) AWS Foundations Benchmark v1.4.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.", + "EnabledByDefault": false + }, + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1", + "Name": "PCI DSS v3.2.1", + "Description": "The Payment Card Industry Data Security Standard (PCI DSS) v3.2.1 is an information security standard for entities that store, process, and/or transmit cardholder data. This Security Hub standard automatically checks for your compliance readiness against a subset of PCI DSS requirements.", + "EnabledByDefault": false + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/standards", @@ -22334,6 +23077,15 @@ ], "traits": { "smithy.api#documentation": "Disables the integration of the specified product with Security Hub. After the integration is\n disabled, findings from that product are no longer sent to Security Hub.
", + "smithy.api#examples": [ + { + "title": "To end a Security Hub integration", + "documentation": "The following example ends an integration between Security Hub and the specified product that sends findings to Security Hub. After the integration ends, the product no longer sends findings to Security Hub.", + "input": { + "ProductSubscriptionArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon" + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/productSubscriptions/{ProductSubscriptionArn+}", @@ -22388,6 +23140,15 @@ ], "traits": { "smithy.api#documentation": "Disables a Security Hub administrator account. Can only be called by the organization\n management account.
", + "smithy.api#examples": [ + { + "title": "To remove a Security Hub administrator account", + "documentation": "The following example removes the Security Hub administrator account in the Region from which the operation was executed. This operation doesn't remove the delegated administrator account in AWS Organizations.", + "input": { + "AdminAccountId": "123456789012" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/organization/admin/disable", @@ -22440,7 +23201,13 @@ } ], "traits": { - "smithy.api#documentation": "Disables Security Hub in your account only in the current Region. To disable Security Hub in all\n Regions, you must submit one request per Region where you have enabled Security Hub.
\nWhen you disable Security Hub for an administrator account, it doesn't disable Security Hub for any associated\n member accounts.
\nWhen you disable Security Hub, your existing findings and insights and any Security Hub configuration\n settings are deleted after 90 days and cannot be recovered. Any standards that were enabled\n are disabled, and your administrator and member account associations are removed.
\nIf you want to save your existing findings, you must export them before you disable\n Security Hub.
", + "smithy.api#documentation": "Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all\n Regions, you must submit one request per Region where you have enabled Security Hub.
\nYou can't disable Security Hub in an account that is currently the Security Hub administrator.
\nWhen you disable Security Hub, your existing findings and insights and any Security Hub configuration\n settings are deleted after 90 days and cannot be recovered. Any standards that were enabled\n are disabled, and your administrator and member account associations are removed.
\nIf you want to save your existing findings, you must export them before you disable\n Security Hub.
", + "smithy.api#examples": [ + { + "title": "To deactivate Security Hub", + "documentation": "The following example deactivates Security Hub for the current account and Region." + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/accounts", @@ -22489,6 +23256,12 @@ ], "traits": { "smithy.api#documentation": "Disassociates the current Security Hub member account from the associated administrator\n account.
\nThis operation is only used by accounts that are not part of an organization. For\n organization accounts, only the administrator account can\n disassociate a member account.
", + "smithy.api#examples": [ + { + "title": "To disassociate requesting account from administrator account", + "documentation": "The following example dissociates the requesting account from its associated administrator account." + } + ], "smithy.api#http": { "method": "POST", "uri": "/administrator/disassociate", @@ -22588,6 +23361,18 @@ ], "traits": { "smithy.api#documentation": "Disassociates the specified member accounts from the associated administrator account.
\nCan be used to disassociate both accounts that are managed using Organizations and accounts that\n were invited manually.
", + "smithy.api#examples": [ + { + "title": "To disassociate member accounts from administrator account", + "documentation": "The following example dissociates the specified member accounts from the associated administrator account.", + "input": { + "AccountIds": [ + "123456789012", + "111122223333" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/members/disassociate", @@ -22677,6 +23462,18 @@ ], "traits": { "smithy.api#documentation": "Enables the integration of a partner product with Security Hub. Integrated products send\n findings to Security Hub.
\nWhen you enable a product integration, a permissions policy that grants permission for\n the product to send findings to Security Hub is applied.
", + "smithy.api#examples": [ + { + "title": "To activate an integration", + "documentation": "The following example activates an integration between Security Hub and a third party partner product that sends findings to Security Hub.", + "input": { + "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon" + }, + "output": { + "ProductSubscriptionArn": "arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/productSubscriptions", @@ -22737,6 +23534,15 @@ ], "traits": { "smithy.api#documentation": "Designates the Security Hub administrator account for an organization. Can only be called by\n the organization management account.
", + "smithy.api#examples": [ + { + "title": "To designate a Security Hub administrator", + "documentation": "The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.", + "input": { + "AdminAccountId": "123456789012" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/organization/admin/enable", @@ -22793,6 +23599,18 @@ ], "traits": { "smithy.api#documentation": "Enables Security Hub for your account in the current Region or the Region you specify in the\n request.
\nWhen you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings\n from other services that are integrated with Security Hub.
\nWhen you use the EnableSecurityHub operation to enable Security Hub, you also\n automatically enable the following standards:
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
\nAmazon Web Services Foundational Security Best Practices
\nOther standards are not automatically enabled.
\nTo opt out of automatically enabled standards, set\n EnableDefaultStandards to false.
After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the\n BatchDisableStandards operation.
To learn more, see the setup information in the Security Hub User Guide.
", + "smithy.api#examples": [ + { + "title": "To activate Security Hub", + "documentation": "The following example activates the Security Hub service in the requesting AWS account. The service is activated in the current AWS Region or the Region that you specify in the request. Some standards are automatically turned on in your account unless you opt out. To determine which standards are automatically turned on, see the Security Hub documentation.", + "input": { + "Tags": { + "Department": "Security" + }, + "EnableDefaultStandards": true + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/accounts", @@ -23189,6 +24007,32 @@ "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails" } }, + "com.amazonaws.securityhub#GeneratorDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the detector used to identify the code vulnerability.\n
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The description of the detector used to identify the code vulnerability.\n
" + } + }, + "Labels": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "\n An array of tags used to identify the detector associated with the finding.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to \n findings that relate to Lambda functions. Amazon Inspector identifies policy violations and \n vulnerabilities in Lambda function code based on internal detectors developed \n in collaboration with Amazon CodeGuru. Security Hub receives those findings.\n
" + } + }, "com.amazonaws.securityhub#GeoLocation": { "type": "structure", "members": { @@ -23287,10 +24131,31 @@ ], "traits": { "smithy.api#documentation": "Returns a list of the standards that are currently enabled.
", - "smithy.api#http": { - "method": "POST", - "uri": "/standards/get", - "code": 200 + "smithy.api#examples": [ + { + "title": "To return a list of enabled standards", + "documentation": "The following example returns a list of Security Hub standards that are currently enabled in your account. ", + "input": { + "StandardsSubscriptionArns": [ + "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + ] + }, + "output": { + "StandardsSubscriptions": [ + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1", + "StandardsInput": {}, + "StandardsStatus": "READY", + "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/standards/get", + "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", @@ -23377,6 +24242,24 @@ ], "traits": { "smithy.api#documentation": "Returns the current finding aggregation configuration.
", + "smithy.api#examples": [ + { + "title": "To get cross-Region aggregation details", + "documentation": "The following example returns cross-Region aggregation details for the requesting account. ", + "input": { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + }, + "output": { + "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "FindingAggregationRegion": "us-east-1", + "RegionLinkingMode": "SPECIFIED_REGIONS", + "Regions": [ + "us-west-1", + "us-west-2" + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/findingAggregator/get/{FindingAggregatorArn+}", @@ -23552,6 +24435,113 @@ ], "traits": { "smithy.api#documentation": "Returns a list of findings that match the specified criteria.
\nIf finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
Lists the results of the Security Hub insight specified by the insight ARN.
", + "smithy.api#examples": [ + { + "title": "To get the results of a Security Hub insight", + "documentation": "The following example returns the results of the Security Hub insight specified by the insight ARN.", + "input": { + "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + }, + "output": { + "InsightResults": { + "GroupByAttribute": "ResourceId", + "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "ResultValues": [ + { + "Count": 10, + "GroupByAttributeValue": "AWS::::Account:111122223333" + }, + { + "Count": 3, + "GroupByAttributeValue": "AWS::::Account:444455556666" + } + ] + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/insights/results/{InsightArn+}", @@ -23711,6 +24726,40 @@ ], "traits": { "smithy.api#documentation": "Lists and describes insights for the specified insight ARNs.
", + "smithy.api#examples": [ + { + "title": "To get details of a Security Hub insight", + "documentation": "The following example returns details of the Security Hub insight with the specified ARN.", + "input": { + "InsightArns": [ + "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + ] + }, + "output": { + "Insights": [ + { + "Filters": { + "ResourceType": [ + { + "Comparison": "EQUALS", + "Value": "AwsIamRole" + } + ], + "SeverityLabel": [ + { + "Comparison": "EQUALS", + "Value": "CRITICAL" + } + ] + }, + "GroupByAttribute": "ResourceId", + "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "Critical role findings" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/insights/get", @@ -23796,6 +24845,15 @@ ], "traits": { "smithy.api#documentation": "Returns the count of all Security Hub membership invitations that were sent to the\n current member account, not including the currently accepted invitation.
", + "smithy.api#examples": [ + { + "title": "To get a count of membership invitations", + "documentation": "The following example returns a count of invitations that the Security Hub administrator sent to the current member account, not including the currently accepted invitation.\n\n", + "output": { + "InvitationsCount": 3 + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/invitations/count", @@ -24263,6 +25321,21 @@ ], "traits": { "smithy.api#documentation": "Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that\n the invitation is sent from.
\nThis operation is only used to invite accounts that do not belong to an organization.\n Organization accounts do not receive invitations.
\nBefore you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.
When the account owner enables Security Hub and accepts the invitation to become a member\n account, the administrator account can view the findings generated from the member account.
", + "smithy.api#examples": [ + { + "title": "To invite accounts to become members", + "documentation": "The following example invites the specified AWS accounts to become member accounts associated with the calling Security Hub administrator account. You only use this operation to invite accounts that don't belong to an AWS Organizations organization.", + "input": { + "AccountIds": [ + "111122223333", + "444455556666" + ] + }, + "output": { + "UnprocessedAccounts": [] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/members/invite", @@ -24447,6 +25520,41 @@ ], "traits": { "smithy.api#documentation": "\n A list of automation rules and their metadata for the calling account.\n
", + "smithy.api#examples": [ + { + "title": "To list automation rules", + "documentation": "The following example lists automation rules and rule metadata in the calling account.", + "input": { + "NextToken": "example-token", + "MaxResults": 2 + }, + "output": { + "AutomationRulesMetadata": [ + { + "RuleName": "sample-rule-name-1", + "RuleOrder": 1, + "Description": "IAM.8 is a known issue and can be resolved", + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RuleStatus": "ENABLED", + "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14", + "CreatedAt": "2022-08-31T01:52:33.250Z", + "UpdatedAt": "2022-08-31T01:52:33.250Z" + }, + { + "RuleName": "sample-rule-name-2", + "RuleOrder": 2, + "Description": "Lambda.2 is a known issue and can be resolved", + "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "RuleStatus": "ENABLED", + "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14", + "CreatedAt": "2022-08-31T01:52:33.250Z", + "UpdatedAt": "2022-08-31T01:52:33.250Z" + } + ], + "NextToken": "example-token" + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/automationrules/list", @@ -24518,6 +25626,18 @@ ], "traits": { "smithy.api#documentation": "Lists all findings-generating solutions (products) that you are subscribed to receive\n findings from in Security Hub.
", + "smithy.api#examples": [ + { + "title": "To list ARNs for enabled integrations", + "documentation": "The following example returns a list of subscription Amazon Resource Names (ARNs) for the product integrations that you have currently enabled in Security Hub.", + "output": { + "ProductSubscriptions": [ + "arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon", + "arn:aws:securityhub:us-east-1::product/3coresec/3coresec" + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/productSubscriptions", @@ -24601,6 +25721,19 @@ ], "traits": { "smithy.api#documentation": "If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
Lists the Security Hub administrator accounts. Can only be called by the organization\n management account.
", + "smithy.api#examples": [ + { + "title": "To list administrator acccounts for an organization", + "documentation": "The following example lists the Security Hub administrator accounts for an organization. Only the organization management account can call this operation.", + "output": { + "AdminAccounts": [ + { + "AccountId": "777788889999" + }, + { + "Status": "ENABLED" + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/organization/admin", @@ -24929,6 +26078,46 @@ ], "traits": { "smithy.api#documentation": "\n Lists all of the security controls that apply to a specified standard. \n
", + "smithy.api#examples": [ + { + "title": "To list security controls that apply to a standard", + "documentation": "The following example lists security controls that apply to a specified Security Hub standard. ", + "input": { + "StandardsArn": "arn:aws:securityhub:::standards/aws-foundational-security-best-practices/v/1.0.0", + "NextToken": "NULL", + "MaxResults": 3 + }, + "output": { + "SecurityControlDefinitions": [ + { + "SecurityControlId": "ACM.1", + "Title": "Imported and ACM-issued certificates should be renewed after a specified time period", + "Description": "This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation", + "SeverityRating": "MEDIUM", + "CurrentRegionAvailability": "AVAILABLE" + }, + { + "SecurityControlId": "APIGateway.1", + "Title": "API Gateway REST and WebSocket API execution logging should be enabled", + "Description": "This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation", + "SeverityRating": "MEDIUM", + "CurrentRegionAvailability": "AVAILABLE" + }, + { + "SecurityControlId": "APIGateway.2", + "Title": "API Gateway REST API stages should be configured to use SSL certificates for backend authentication", + "Description": "This control checks whether Amazon API Gateway REST API stages have SSL certificates configured that backend systems can use to authenticate that incoming requests are from the API Gateway.", + "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.2/remediation", + "SeverityRating": "MEDIUM", + "CurrentRegionAvailability": "AVAILABLE" + } + ], + "NextToken": "U2FsdGVkX1..." + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/securityControls/definitions", @@ -25103,6 +26292,21 @@ ], "traits": { "smithy.api#documentation": "Returns a list of tags associated with a resource.
", + "smithy.api#examples": [ + { + "title": "To get a list of tags for a resource", + "documentation": "The following example returns a list of tags associated with the specified resource.", + "input": { + "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default" + }, + "output": { + "Tags": { + "Department": "Operations", + "Area": "USMidwest" + } + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -28018,7 +29222,7 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Security Hub provides you with a comprehensive view of the security state of\n your Amazon Web Services environment and resources. It also provides you with the readiness\n status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and\n integrated third-party products and helps you analyze security trends in your environment\n to identify the highest priority security issues. For more information about Security Hub, see the Security HubUser\n Guide.
\nWhen you use operations in the Security Hub API, the requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, run the same command for each Region in which you want to apply the change.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1 request per\n second. BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n UpdateStandardsControl - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
Security Hub provides you with a comprehensive view of the security state of\n your Amazon Web Services environment and resources. It also provides you with the readiness\n status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and\n integrated third-party products and helps you analyze security trends in your environment\n to identify the highest priority security issues. For more information about Security Hub, see the \n Security Hub User \nGuide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, run the same command for each Region in which you want to apply the change.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1 request per\n second. BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
\n UpdateStandardsControl - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
Adds one or more tags to a resource.
", + "smithy.api#examples": [ + { + "title": "To tag a resource", + "documentation": "The following example adds the 'Department' and 'Area' tags to the specified resource.", + "input": { + "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default", + "Tags": { + "Department": "Operations", + "Area": "USMidwest" + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -30541,6 +31722,18 @@ ], "traits": { "smithy.api#documentation": "Removes one or more tags from a resource.
", + "smithy.api#examples": [ + { + "title": "To remove tags from a resource", + "documentation": "The following example removes the 'Department' tag from the specified resource.", + "input": { + "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default", + "TagKeys": [ + "Department" + ] + } + } + ], "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", @@ -30603,6 +31796,17 @@ ], "traits": { "smithy.api#documentation": "Updates the name and description of a custom action target in Security Hub.
", + "smithy.api#examples": [ + { + "title": "To update the name and description of a custom action target", + "documentation": "The following example updates the name and description of a custom action target in Security Hub. You can create custom actions to automatically respond to Security Hub findings using Amazon EventBridge. ", + "input": { + "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation", + "Name": "Chat custom action", + "Description": "Sends specified findings to customer service chat" + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/actionTargets/{ActionTargetArn+}", @@ -30746,6 +31950,29 @@ ], "traits": { "smithy.api#documentation": "Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.
You must run UpdateFindingAggregator from the current aggregation Region.\n
Updates the Security Hub insight identified by the specified insight ARN.
", + "smithy.api#examples": [ + { + "title": "To update an insight", + "documentation": "The following example updates the specified Security Hub insight.", + "input": { + "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "High severity role findings", + "Filters": { + "ResourceType": [ + { + "Comparison": "EQUALS", + "Value": "AwsIamRole" + } + ], + "SeverityLabel": [ + { + "Comparison": "EQUALS", + "Value": "HIGH" + } + ] + } + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/insights/{InsightArn+}", @@ -30980,6 +32231,15 @@ ], "traits": { "smithy.api#documentation": "Used to update the configuration related to Organizations. Can only be called from a\n Security Hub administrator account.
", + "smithy.api#examples": [ + { + "title": "To update organization configuration", + "documentation": "The following example updates the configuration for an organization so that Security Hub is automatically activated for new member accounts. Only the Security Hub administrator account can call this operation.", + "input": { + "AutoEnable": true + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/organization/configuration", @@ -31043,6 +32303,16 @@ ], "traits": { "smithy.api#documentation": "Updates configuration options for Security Hub.
", + "smithy.api#examples": [ + { + "title": "To update Security Hub settings", + "documentation": "The following example updates Security Hub settings to turn on consolidated control findings, and to automatically enable new controls in enabled standards.", + "input": { + "AutoEnableControls": true, + "ControlFindingGenerator": "SECURITY_CONTROL" + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/accounts", @@ -31102,6 +32372,17 @@ ], "traits": { "smithy.api#documentation": "Used to control whether an individual security standard control is enabled or\n disabled.
", + "smithy.api#examples": [ + { + "title": "To update the enablement status of a standard control", + "documentation": "The following example disables the specified control in the specified security standard.", + "input": { + "StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1", + "ControlStatus": "DISABLED", + "DisabledReason": "Not applicable to my service" + } + } + ], "smithy.api#http": { "method": "PATCH", "uri": "/standards/control/{StandardsControlArn+}", @@ -31313,12 +32594,80 @@ "traits": { "smithy.api#documentation": "Specifies if all vulnerable packages in a finding have a value for FixedInVersion \nand Remediation.\nThis field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both \nFixedInVersion and Remediation. Valid values are as follows:
\n YES if all vulnerable packages have a value for both FixedInVersion and Remediation\n
\n NO if no vulnerable packages have a value for FixedInVersion and Remediation\n
\n PARTIAL otherwise
The Exploit Prediction Scoring System (EPSS) score for a finding. \n\t\t
" + } + }, + "ExploitAvailable": { + "target": "com.amazonaws.securityhub#VulnerabilityExploitAvailable", + "traits": { + "smithy.api#documentation": "Whether an exploit is available for a finding.\n\t\t
" + } + }, + "CodeVulnerabilities": { + "target": "com.amazonaws.securityhub#VulnerabilityCodeVulnerabilitiesList", + "traits": { + "smithy.api#documentation": "The vulnerabilities found in your Lambda function code. This field pertains to findings that \nSecurity Hub receives from Amazon Inspector.\n
" + } } }, "traits": { "smithy.api#documentation": "A vulnerability associated with a finding.
" } }, + "com.amazonaws.securityhub#VulnerabilityCodeVulnerabilities": { + "type": "structure", + "members": { + "Cwes": { + "target": "com.amazonaws.securityhub#TypeList", + "traits": { + "smithy.api#documentation": "\n The Common Weakness Enumeration (CWE) item associated with the detected code vulnerability.\n
" + } + }, + "FilePath": { + "target": "com.amazonaws.securityhub#CodeVulnerabilitiesFilePath", + "traits": { + "smithy.api#documentation": "\n Provides details about where a code vulnerability is located in your Lambda function.\n
" + } + }, + "SourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Lambda layer in which the code vulnerability is located.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about the vulnerabilities found in your Lambda function code. This field pertains to findings that \n Security Hub receives from Amazon Inspector.\n
" + } + }, + "com.amazonaws.securityhub#VulnerabilityCodeVulnerabilitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VulnerabilityCodeVulnerabilities" + } + }, + "com.amazonaws.securityhub#VulnerabilityExploitAvailable": { + "type": "enum", + "members": { + "YES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YES" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + } + } + }, "com.amazonaws.securityhub#VulnerabilityFixAvailable": { "type": "enum", "members": { @@ -31446,7 +32795,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the status of the investigation into a finding.
" + "smithy.api#documentation": "Provides details about the status of the investigation into a finding.
" } }, "com.amazonaws.securityhub#WorkflowState": {