\n
... more content ... \n",
"versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs="
}
```
For more information, see [View package version readme file](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#view-package-readme) in the *AWS CodeArtifact User Guide*.
+ For API details, see [GetPackageVersionReadme](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-package-version-readme.html) in *AWS CLI Command Reference*.
### `get-repository-endpoint`
The following code example shows how to use `get-repository-endpoint`.
**AWS CLI**
**To get a repository's URL endpoint**
The following `get-repository-endpoint` example returns the npm endpoint for the test-repo repository.
```
aws codeartifact get-repository-endpoint \
--domain test-domain \
--repository test-repo \
--format npm
```
Output:
```
{
"repositoryEndpoint": "https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/"
}
```
For more information, see [Connect to a repository](https://docs.aws.amazon.com/codeartifact/latest/ug/connect-repo.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [GetRepositoryEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-endpoint.html) in *AWS CLI Command Reference*.
### `get-repository-permissions-policy`
The following code example shows how to use `get-repository-permissions-policy`.
**AWS CLI**
**To get the permissions policy document for a repository**
The following `get-repository-permissions-policy` example gets the permission policy attached to a repository named test-repo.
```
aws codeartifact get-repository-permissions-policy \
--domain test-domain \
--repository test-repo
```
Output:
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::111122223333:root"
},
"Action": [
"codeartifact:DescribePackageVersion",
"codeartifact:DescribeRepository",
"codeartifact:GetPackageVersionReadme",
"codeartifact:GetRepositoryEndpoint",
"codeartifact:ListPackages",
"codeartifact:ListPackageVersions",
"codeartifact:ListPackageVersionAssets",
"codeartifact:ListPackageVersionDependencies",
"codeartifact:ReadFromRepository"
],
"Resource": "*"
}
]
}
```
For more information, see [Read a policy](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy) in the *AWS CodeArtifact User Guide*.
+ For API details, see [GetRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-permissions-policy.html) in *AWS CLI Command Reference*.
### `list-domains`
The following code example shows how to use `list-domains`.
**AWS CLI**
**To list domains**
The following `list-domains` example returns a summary of all domains owned by the AWS account that makes the call.
```
aws codeartifact list-domains
```
Output:
```
{
"domains": [
{
"name": "my-domain",
"owner": "111122223333",
"status": "Active",
"encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"name": "test-domain",
"owner": "111122223333",
"status": "Active",
"encryptionKey": "arn:aws:kms:us-west-2:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
]
}
```
For more information, see [Working with domains in CodeArtifact](https://docs.aws.amazon.com/codeartifact/latest/ug/domains.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-domains.html) in *AWS CLI Command Reference*.
### `list-package-version-assets`
The following code example shows how to use `list-package-version-assets`.
**AWS CLI**
**To view a package version's assets**
The following `list-package-version-assets` example retrieves the assets for version 4.0.0 of an npm package named test-package.
```
aws codeartifact list-package-version-assets \
--domain test-domain \
--repo test-repo \
--format npm \
--package test-package \
--package-version 4.0.0
```
Output:
```
{
"format": "npm",
"package": "test-package",
"version": "4.0.0",
"versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=",
"assets": [
{
"name": "package.tgz",
"size": 316680,
"hashes": {
"MD5": "60078ec6d9e76b89fb55c860832742b2",
"SHA-1": "b44a9b6297bcb698f1c51a3545a2b3b368d59c52",
"SHA-256": "d2aa8c6afc3c8591765785a37d1c5acae482a8eb3ab9729ed28922692454f2e2",
"SHA-512": "3e585d15c8a594e20d7de57b362ea81754c011acb2641a19f1b72c8531ea39825896bab344ae616a0a5a824cb9a381df0b3cddd534645cf305aba70a93dac698"
}
}
]
}
```
For more information, see [List package version assets](https://docs.aws.amazon.com/codeartifact/latest/ug/list-assets.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListPackageVersionAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-assets.html) in *AWS CLI Command Reference*.
### `list-package-version-dependencies`
The following code example shows how to use `list-package-version-dependencies`.
**AWS CLI**
**To view a package version's dependencies**
The following `list-package-version-dependencies` example retrieves the dependencies for version 4.0.0 of an npm package named test-package.
```
aws codeartifact list-package-version-dependencies \
--domain test-domain \
--repo test-repo \
--format npm \
--package test-package \
--package-version 4.0.0
```
Output:
```
{
"format": "npm",
"package": "test-package",
"version": "4.0.0",
"versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=",
"dependencies": [
{
"namespace": "testns",
"package": "testdep1",
"dependencyType": "regular",
"versionRequirement": "1.8.5"
},
{
"namespace": "testns",
"package": "testdep2",
"dependencyType": "regular",
"versionRequirement": "1.8.5"
}
]
}
```
For more information, see [View and update package version details and dependencies](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListPackageVersionDependencies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-dependencies.html) in *AWS CLI Command Reference*.
### `list-package-versions`
The following code example shows how to use `list-package-versions`.
**AWS CLI**
**To list package versions for a package**
The following `list-package-versions` example returns a list of package versions for a package named `kind-of`.
```
aws codeartifact list-package-versions \
--package kind-of \
--domain test-domain \
--repository test-repo \
--format npm
```
Output:
```
{
"defaultDisplayVersion": "1.0.1",
"format": "npm",
"package": "kind-of",
"versions": [
{
"version": "1.0.1",
"revision": "REVISION-SAMPLE-1-C7F4S5E9B772FC",
"status": "Published"
},
{
"version": "1.0.0",
"revision": "REVISION-SAMPLE-2-C752BEEF6D2CFC",
"status": "Published"
},
{
"version": "0.1.2",
"revision": "REVISION-SAMPLE-3-654S65A5C5E1FC",
"status": "Published"
},
{
"version": "0.1.1",
"revision": "REVISION-SAMPLE-1-C7F4S5E9B772FC"",
"status": "Published"
},
{
"version": "0.1.0",
"revision": "REVISION-SAMPLE-4-AF669139B772FC",
"status": "Published"
}
]
}
```
For more information, see [List package versions](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages-versions.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListPackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-versions.html) in *AWS CLI Command Reference*.
### `list-packages`
The following code example shows how to use `list-packages`.
**AWS CLI**
**To list packages in a repository**
The following `list-packages` example list packages in a repository named `test-repo` in a domain named `test-domain`.
```
aws codeartifact list-packages \
--domain test-domain \
--repository test-repo
```
Output:
```
{
"packages": [
{
"format": "npm",
"package": "lodash"
}
{
"format": "python",
"package": "test-package"
}
]
}
```
For more information, see [List package names](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-packages.html) in *AWS CLI Command Reference*.
### `list-repositories-in-domain`
The following code example shows how to use `list-repositories-in-domain`.
**AWS CLI**
**To list repositories in a domain**
The following `list-repositories-in-domain` example returns a summary of all repositories in the test-domain domain.
```
aws codeartifact list-repositories-in-domain \
--domain test-domain
```
Output:
```
{
"repositories": [
{
"name": "test-repo",
"administratorAccount": "111122223333",
"domainName": "test-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo",
"description": "This is a test repository."
},
{
"name": "test-repo2",
"administratorAccount": "111122223333",
"domainName": "test-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo2",
"description": "This is a test repository."
}
]
}
```
For more information, see [List repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListRepositoriesInDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories-in-domain.html) in *AWS CLI Command Reference*.
### `list-repositories`
The following code example shows how to use `list-repositories`.
**AWS CLI**
**To list repositories**
The following `list-repositories` example returns a summary of all repositories in domain owned by the AWS account that makes the call.
```
aws codeartifact list-repositories
```
Output:
```
{
"repositories": [
{
"name": "npm-store",
"administratorAccount": "111122223333",
"domainName": "my-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/my-domain/npm-store",
"description": "Provides npm artifacts from npm, Inc."
},
{
"name": "target-repo",
"administratorAccount": "111122223333",
"domainName": "my-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/my-domain/target-repo",
"description": "test target repo"
},
{
"name": "test-repo2",
"administratorAccount": "111122223333",
"domainName": "test-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo2",
"description": "This is a test repository."
}
]
}
```
For more information, see [List repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories.html) in *AWS CLI Command Reference*.
### `login`
The following code example shows how to use `login`.
**AWS CLI**
**To configure authentication to your repository with the login command**
The following `login` example configures the npm package manager with a repository named test-repo in a domain named test-domain.
```
aws codeartifact login \
--domain test-domain \
--repository test-repo \
--tool npm
```
Output:
```
Successfully configured npm to use AWS CodeArtifact repository https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/
Login expires in 12 hours at 2020-11-12 01:53:16-05:00
```
For more information, see [Getting started with the AWS CLI](https://docs.aws.amazon.com/codeartifact/latest/ug/getting-started-cli.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [Login](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/login.html) in *AWS CLI Command Reference*.
### `put-domain-permissions-policy`
The following code example shows how to use `put-domain-permissions-policy`.
**AWS CLI**
**To attach a permissions policy to a domain**
The following `put-domain-permissions-policy` example attaches a permission policy that is defined in the policy.json file to a domain named test-domain.
```
aws codeartifact put-domain-permissions-policy \
--domain test-domain \
--policy-document file://PATH/TO/policy.json
```
Output:
```
{
"policy": {
"resourceArn": "arn:aws:codeartifact:region-id:111122223333:domain/test-domain",
"document": "{ ...policy document content...}",
"revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx="
}
}
```
For more information, see [Set a domain policy](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#set-domain-policy) in the *AWS CodeArtifact User Guide*.
+ For API details, see [PutDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-domain-permissions-policy.html) in *AWS CLI Command Reference*.
### `put-repository-permissions-policy`
The following code example shows how to use `put-repository-permissions-policy`.
**AWS CLI**
**To attach a permissions policy to a repository**
The following `put-repository-permissions-policy` example attaches a permission policy that is defined in the policy.json file to a repository named test-repo.
```
aws codeartifact put-repository-permissions-policy \
--domain test-domain \
--repository test-repo \
--policy-document file://PATH/TO/policy.json
```
Output:
```
{
"policy": {
"resourceArn": "arn:aws:codeartifact:region-id:111122223333:repository/test-domain/test-repo",
"document": "{ ...policy document content...}",
"revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx="
}
}
```
For more information, see [Set a policy](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy) in the *AWS CodeArtifact User Guide*.
+ For API details, see [PutRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-repository-permissions-policy.html) in *AWS CLI Command Reference*.
### `update-package-versions-status`
The following code example shows how to use `update-package-versions-status`.
**AWS CLI**
**To update package version status**
The following `update-package-versions-status` example updates the status of version 4.0.0 of the test-package package to Archived.
```
aws codeartifact update-package-versions-status \
--domain test-domain \
--repo test-repo \
--format npm \
--package test-package \
--versions 4.0.0 \
--target-status Archived
```
Output:
```
{
"successfulVersions": {
"4.0.0": {
"revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=",
"status": "Archived"
}
},
"failedVersions": {}
}
```
For more information, see [Update package version status](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#update-package-version-status) in the *AWS CodeArtifact User Guide*.
+ For API details, see [UpdatePackageVersionsStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-package-versions-status.html) in *AWS CLI Command Reference*.
### `update-repository`
The following code example shows how to use `update-repository`.
**AWS CLI**
**To update a repository**
The following `update-repository` example updates the description of a repo named test-repo in a domain named test-domain to "this is an updated description".
```
aws codeartifact update-repository \
--domain test-domain \
--repository test-repo \
--description "this is an updated description"
```
Output:
```
{
"repository": {
"name": "test-repo",
"administratorAccount": "111122223333",
"domainName": "test-domain",
"domainOwner": "111122223333",
"arn": "arn:aws:codeartifact:us-west-2:111122223333:repository/test-domain/test-repo",
"description": "this is an updated description",
"upstreams": [],
"externalConnections": []
}
}
```
For more information, see [View or modify a repository configuration](https://docs.aws.amazon.com/codeartifact/latest/ug/config-repos.html) in the *AWS CodeArtifact User Guide*.
+ For API details, see [UpdateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-repository.html) in *AWS CLI Command Reference*.
# CodeBuild examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodeBuild.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `batch-delete-builds`
The following code example shows how to use `batch-delete-builds`.
**AWS CLI**
**To delete builds in AWS CodeBuild.**
The following `batch-delete-builds` example deletes builds in CodeBuild with the specified IDs.
```
aws codebuild batch-delete-builds --ids my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE
```
Output:
```
{
"buildsNotDeleted": [
{
"id": "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE",
"statusCode": "BUILD_IN_PROGRESS"
}
],
"buildsDeleted": [
"arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE"
]
}
```
For more information, see [Delete Builds (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-builds.html#delete-builds-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchDeleteBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-delete-builds.html) in *AWS CLI Command Reference*.
### `batch-get-build-batches`
The following code example shows how to use `batch-get-build-batches`.
**AWS CLI**
**To view details of builds in AWS CodeBuild.**
The following `batch-get-build-batches` example gets information about build batches in CodeBuild with the specified IDs.
```
aws codebuild batch-get-build-batches \
--ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE
```
Output:
```
{
"buildBatches": [
{
"id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
"arn": "arn:aws:codebuild:us-west-2:123456789012:build-batch/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
"startTime": "2020-11-03T21:52:20.775000+00:00",
"endTime": "2020-11-03T21:56:59.784000+00:00",
"currentPhase": "SUCCEEDED",
"buildBatchStatus": "SUCCEEDED",
"resolvedSourceVersion": "0a6546f68309560d08a310daac92314c4d378f6b",
"projectName": "codebuild-demo-project",
"phases": [
{
"phaseType": "SUBMITTED",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-11-03T21:52:20.775000+00:00",
"endTime": "2020-11-03T21:52:20.976000+00:00",
"durationInSeconds": 0
},
{
"phaseType": "DOWNLOAD_BATCHSPEC",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-11-03T21:52:20.976000+00:00",
"endTime": "2020-11-03T21:52:57.401000+00:00",
"durationInSeconds": 36
},
{
"phaseType": "IN_PROGRESS",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-11-03T21:52:57.401000+00:00",
"endTime": "2020-11-03T21:56:59.751000+00:00",
"durationInSeconds": 242
},
{
"phaseType": "COMBINE_ARTIFACTS",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-11-03T21:56:59.751000+00:00",
"endTime": "2020-11-03T21:56:59.784000+00:00",
"durationInSeconds": 0
},
{
"phaseType": "SUCCEEDED",
"startTime": "2020-11-03T21:56:59.784000+00:00"
}
],
"source": {
"type": "GITHUB",
"location": "https://github.com/my-repo/codebuild-demo-project.git",
"gitCloneDepth": 1,
"gitSubmodulesConfig": {
"fetchSubmodules": false
},
"reportBuildStatus": false,
"insecureSsl": false
},
"secondarySources": [],
"secondarySourceVersions": [],
"artifacts": {
"location": ""
},
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [],
"privilegedMode": false,
"imagePullCredentialsType": "CODEBUILD"
},
"logConfig": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED",
"encryptionDisabled": false
}
},
"buildTimeoutInMinutes": 60,
"queuedTimeoutInMinutes": 480,
"complete": true,
"initiator": "Strohm",
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"buildBatchNumber": 6,
"buildBatchConfig": {
"serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-demo-project",
"restrictions": {
"maximumBuildsAllowed": 100
},
"timeoutInMins": 480
},
"buildGroups": [
{
"identifier": "DOWNLOAD_SOURCE",
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:379737d8-bc35-48ec-97fd-776d27545315",
"requestedOn": "2020-11-03T21:52:21.394000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "DOWNLOAD_SOURCE"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_small",
"dependsOn": [],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:dd785171-ed84-4bb6-8ede-ceeb86e54bdb",
"requestedOn": "2020-11-03T21:52:57.604000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "linux_small"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_medium",
"dependsOn": [
"linux_small"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:97cf7bd4-5313-4786-8243-4aef350a1267",
"requestedOn": "2020-11-03T21:54:18.474000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "linux_medium"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_large",
"dependsOn": [
"linux_medium"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:60a194cd-0d03-4337-9db1-d41476a17d27",
"requestedOn": "2020-11-03T21:55:39.203000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "linux_large"
},
"secondaryArtifacts": []
}
}
]
}
],
"buildBatchesNotFound": []
}
```
For more information, see Batch builds in AWS CodeBuild
)\$1\$1 in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchGetBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-build-batches.html) in *AWS CLI Command Reference*.
### `batch-get-builds`
The following code example shows how to use `batch-get-builds`.
**AWS CLI**
**To view details of builds in AWS CodeBuild.**
The following `batch-get-builds` example gets information about builds in CodeBuild with the specified IDs.
```
aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE
```
Output:
```
{
"buildsNotFound": [],
"builds": [
{
"artifacts": {
"md5sum": "0e95edf915048a0c22efe6d139fff837",
"location": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/BuildArtif/6DJsqQa",
"encryptionDisabled": false,
"sha256sum": "cfa0df33a090966a737f64ae4fe498969fdc842a0c9aec540bf93c37ac0d05a2"
},
"logs": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED"
},
"streamName": "46472baf-8f6b-43c2-9255-b3b963af2732",
"groupName": "/aws/codebuild/codebuild-demo-project",
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=46472baf-8f6b-43c2-9255-b3b963af2732"
},
"timeoutInMinutes": 60,
"environment": {
"privilegedMode": false,
"computeType": "BUILD_GENERAL1_MEDIUM",
"image": "aws/codebuild/windows-base:1.0",
"environmentVariables": [],
"type": "WINDOWS_CONTAINER"
},
"projectName": "codebuild-demo-project",
"buildComplete": true,
"source": {
"gitCloneDepth": 1,
"insecureSsl": false,
"type": "CODEPIPELINE"
},
"buildStatus": "SUCCEEDED",
"secondaryArtifacts": [],
"phases": [
{
"durationInSeconds": 0,
"startTime": 1548717462.122,
"phaseType": "SUBMITTED",
"endTime": 1548717462.484,
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"startTime": 1548717462.484,
"phaseType": "QUEUED",
"endTime": 1548717462.775,
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 34,
"endTime": 1548717496.909,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717462.775,
"phaseType": "PROVISIONING",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 15,
"endTime": 1548717512.555,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717496.909,
"phaseType": "DOWNLOAD_SOURCE",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"endTime": 1548717512.734,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717512.555,
"phaseType": "INSTALL",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"endTime": 1548717512.924,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717512.734,
"phaseType": "PRE_BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 9,
"endTime": 1548717522.254,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717512.924,
"phaseType": "BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 3,
"endTime": 1548717525.498,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717522.254,
"phaseType": "POST_BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 9,
"endTime": 1548717534.646,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717525.498,
"phaseType": "UPLOAD_ARTIFACTS",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 2,
"endTime": 1548717536.846,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548717534.646,
"phaseType": "FINALIZING",
"phaseStatus": "SUCCEEDED"
},
{
"startTime": 1548717536.846,
"phaseType": "COMPLETED"
}
],
"startTime": 1548717462.122,
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"initiator": "codepipeline/CodeBuild-Pipeline",
"secondarySources": [],
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"currentPhase": "COMPLETED",
"id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
"cache": {
"type": "NO_CACHE"
},
"sourceVersion": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/SourceArti/1TspnN3.zip",
"endTime": 1548717536.846,
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE",
"queuedTimeoutInMinutes": 480,
"resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b"
},
{
"artifacts": {
"md5sum": "",
"overrideArtifactName": false,
"location": "arn:aws:s3:::my-artifacts/codebuild-demo-project",
"encryptionDisabled": false,
"sha256sum": ""
},
"logs": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED"
},
"streamName": "4dea3ca4-20ec-4898-b22a-a9eb9292775d",
"groupName": "/aws/codebuild/codebuild-demo-project",
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=4dea3ca4-20ec-4898-b22a-a9eb9292775d"
},
"timeoutInMinutes": 60,
"environment": {
"privilegedMode": false,
"computeType": "BUILD_GENERAL1_MEDIUM",
"image": "aws/codebuild/windows-base:1.0",
"environmentVariables": [],
"type": "WINDOWS_CONTAINER"
},
"projectName": "codebuild-demo-project",
"buildComplete": true,
"source": {
"gitCloneDepth": 1,
"location": "https://github.com/my-repo/codebuild-demo-project.git",
"insecureSsl": false,
"reportBuildStatus": false,
"type": "GITHUB"
},
"buildStatus": "SUCCEEDED",
"secondaryArtifacts": [],
"phases": [
{
"durationInSeconds": 0,
"startTime": 1548716241.89,
"phaseType": "SUBMITTED",
"endTime": 1548716242.241,
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"startTime": 1548716242.241,
"phaseType": "QUEUED",
"endTime": 1548716242.536,
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 33,
"endTime": 1548716276.171,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716242.536,
"phaseType": "PROVISIONING",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 15,
"endTime": 1548716291.809,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716276.171,
"phaseType": "DOWNLOAD_SOURCE",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"endTime": 1548716291.993,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716291.809,
"phaseType": "INSTALL",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 0,
"endTime": 1548716292.191,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716291.993,
"phaseType": "PRE_BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 9,
"endTime": 1548716301.622,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716292.191,
"phaseType": "BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 3,
"endTime": 1548716304.783,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716301.622,
"phaseType": "POST_BUILD",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 8,
"endTime": 1548716313.775,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716304.783,
"phaseType": "UPLOAD_ARTIFACTS",
"phaseStatus": "SUCCEEDED"
},
{
"durationInSeconds": 2,
"endTime": 1548716315.935,
"contexts": [
{
"statusCode": "",
"message": ""
}
],
"startTime": 1548716313.775,
"phaseType": "FINALIZING",
"phaseStatus": "SUCCEEDED"
},
{
"startTime": 1548716315.935,
"phaseType": "COMPLETED"
}
],
"startTime": 1548716241.89,
"secondarySourceVersions": [],
"initiator": "my-codebuild-project",
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE",
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"currentPhase": "COMPLETED",
"id": "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE",
"cache": {
"type": "NO_CACHE"
},
"endTime": 1548716315.935,
"secondarySources": [],
"queuedTimeoutInMinutes": 480,
"resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b"
}
]
}
```
For more information, see [View Build Details (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-details.html#view-build-details-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchGetBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-builds.html) in *AWS CLI Command Reference*.
### `batch-get-projects`
The following code example shows how to use `batch-get-projects`.
**AWS CLI**
**To get a list of AWS CodeBuild build project names.**
The following `batch-get-projects` example gets a list of CodeBuild build projects specified by name.
```
aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project
```
In the following output, the `projectsNotFound` array lists any build project names that were specified, but not found. The `projects` array lists details for each build project where information was found.
```
{
"projectsNotFound": [],
"projects": [
{
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"name": "codebuild-demo-project2",
"queuedTimeoutInMinutes": 480,
"timeoutInMinutes": 60,
"source": {
"buildspec": "version: 0.2\n\n#env:\n #variables:\n # key: \"value\"\n # key: \"value\"\n #parameter-store:\n # key: \"value\"\n # key:\"value\"\n\nphases:\n #install:\n #commands:\n # - command\n # - command\n #pre_build:\n #commands:\n # - command\n # - command\n build:\n commands:\n # - command\n # - command\n #post_build:\n #commands:\n # - command\n # - command\n#artifacts:\n #files:\n # - location\n # - location\n #name: $(date +%Y-%m-%d)\n #discard-paths: yes\n #base-directory: location\n#cache:\n #paths:\n # - paths",
"type": "NO_SOURCE",
"insecureSsl": false,
"gitCloneDepth": 1
},
"artifacts": {
"type": "NO_ARTIFACTS"
},
"badge": {
"badgeEnabled": false
},
"lastModified": 1540588091.108,
"created": 1540588091.108,
"arn": "arn:aws:codebuild:us-west-2:123456789012:project/test-for-sample",
"secondarySources": [],
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-test-role",
"environment": {
"image": "aws/codebuild/java:openjdk-8",
"privilegedMode": true,
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": []
},
"tags": []
},
{
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"name": "my-other-demo-project",
"queuedTimeoutInMinutes": 480,
"timeoutInMinutes": 60,
"source": {
"location": "https://github.com/iversonic/codedeploy-sample.git",
"reportBuildStatus": false,
"buildspec": "buildspec.yml",
"insecureSsl": false,
"gitCloneDepth": 1,
"type": "GITHUB",
"auth": {
"type": "OAUTH"
}
},
"artifacts": {
"type": "NO_ARTIFACTS"
},
"badge": {
"badgeEnabled": false
},
"lastModified": 1523401711.73,
"created": 1523401711.73,
"arn": "arn:aws:codebuild:us-west-2:123456789012:project/Project2",
"cache": {
"type": "NO_CACHE"
},
"serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-Project2-service-role",
"environment": {
"image": "aws/codebuild/nodejs:4.4.7",
"privilegedMode": false,
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": []
},
"tags": []
}
]
}
```
For more information, see [View a Build Project's Details (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-details.html#view-project-details-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchGetProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-projects.html) in *AWS CLI Command Reference*.
### `batch-get-report-groups`
The following code example shows how to use `batch-get-report-groups`.
**AWS CLI**
**To get information about one or more report groups in AWS CodeBuild.**
The following `batch-get-report-groups` example retrieves information about the report group with the specified ARN.
```
aws codebuild batch-get-report-groups \
--report-group-arns arn:aws:codebuild:::report-group/
```
Output:
```
{
"reportGroups": [
{
"arn": "arn:aws:codebuild:::report-group/",
"name": "report-group-name",
"type": "TEST",
"exportConfig": {
"exportConfigType": "NO_EXPORT"
},
"created": "2020-10-01T18:04:08.466000+00:00",
"lastModified": "2020-10-01T18:04:08.466000+00:00",
"tags": []
}
],
"reportGroupsNotFound": []
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchGetReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-report-groups.html) in *AWS CLI Command Reference*.
### `batch-get-reports`
The following code example shows how to use `batch-get-reports`.
**AWS CLI**
**To get information about one or more reports in AWS CodeBuild.**
The following `batch-get-reports` example retrieves information about the reports with the specified ARNs.
```
aws codebuild batch-get-reports \
--report-arns arn:aws:codebuild:::report/: arn:aws:codebuild:::report/:
```
Output:
```
{
"reports": [
{
"arn": "arn:aws:codebuild:::report/:",
"type": "TEST",
"name": "",
"reportGroupArn": "arn:aws:codebuild:::report-group/",
"executionId": "arn:aws:codebuild:::build/test-reports:",
"status": "FAILED",
"created": "2020-10-01T11:25:22.531000-07:00",
"expired": "2020-10-31T11:25:22-07:00",
"exportConfig": {
"exportConfigType": "NO_EXPORT"
},
"truncated": false,
"testSummary": {
"total": 28,
"statusCounts": {
"ERROR": 5,
"FAILED": 1,
"SKIPPED": 4,
"SUCCEEDED": 18,
"UNKNOWN": 0
},
"durationInNanoSeconds": 94000000
}
},
{
"arn": "arn:aws:codebuild:::report/:",
"type": "TEST",
"name": "",
"reportGroupArn": "arn:aws:codebuild:::report-group/",
"executionId": "arn:aws:codebuild:::build/test-reports:",
"status": "FAILED",
"created": "2020-10-01T11:13:05.816000-07:00",
"expired": "2020-10-31T11:13:05-07:00",
"exportConfig": {
"exportConfigType": "NO_EXPORT"
},
"truncated": false,
"testSummary": {
"total": 28,
"statusCounts": {
"ERROR": 5,
"FAILED": 1,
"SKIPPED": 4,
"SUCCEEDED": 18,
"UNKNOWN": 0
},
"durationInNanoSeconds": 94000000
}
}
],
"reportsNotFound": []
}
```
For more information, see [Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [BatchGetReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-reports.html) in *AWS CLI Command Reference*.
### `create-project`
The following code example shows how to use `create-project`.
**AWS CLI**
**Example 1: To create an AWS CodeBuild build project**
The following `create-project` example creates a CodeBuild build project using source files from an S3 bucket
```
aws codebuild create-project \
--name "my-demo-project" \
--source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source.zip\"}" \
--artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket\""} \
--environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_SMALL\"}" \
--service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role"
```
Output:
```
{
"project": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project",
"name": "my-cli-demo-project",
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"lastModified": 1556839783.274,
"badge": {
"badgeEnabled": false
},
"queuedTimeoutInMinutes": 480,
"environment": {
"image": "aws/codebuild/standard:1.0",
"computeType": "BUILD_GENERAL1_SMALL",
"type": "LINUX_CONTAINER",
"imagePullCredentialsType": "CODEBUILD",
"privilegedMode": false,
"environmentVariables": []
},
"artifacts": {
"location": "codebuild-us-west-2-123456789012-output-bucket",
"name": "my-cli-demo-project",
"namespaceType": "NONE",
"type": "S3",
"packaging": "NONE",
"encryptionDisabled": false
},
"source": {
"type": "S3",
"location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip",
"insecureSsl": false
},
"timeoutInMinutes": 60,
"cache": {
"type": "NO_CACHE"
},
"created": 1556839783.274
}
}
```
**Example 2: To create an AWS CodeBuild build project using a JSON input file for the parameters**
The following `create-project` example creates a CodeBuild build project by passing all of the required parameters in a JSON input file. Create the input file template by running the command with only the `--generate-cli-skeleton parameter`.
```
aws codebuild create-project --cli-input-json file://create-project.json
```
The input JSON file `create-project.json` contains the following content:
```
{
"name": "codebuild-demo-project",
"source": {
"type": "S3",
"location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip"
},
"artifacts": {
"type": "S3",
"location": "codebuild-region-ID-account-ID-output-bucket"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/standard:1.0",
"computeType": "BUILD_GENERAL1_SMALL"
},
"serviceRole": "serviceIAMRole"
}
```
Output:
```
{
"project": {
"name": "codebuild-demo-project",
"serviceRole": "serviceIAMRole",
"tags": [],
"artifacts": {
"packaging": "NONE",
"type": "S3",
"location": "codebuild-region-ID-account-ID-output-bucket",
"name": "message-util.zip"
},
"lastModified": 1472661575.244,
"timeoutInMinutes": 60,
"created": 1472661575.244,
"environment": {
"computeType": "BUILD_GENERAL1_SMALL",
"image": "aws/codebuild/standard:1.0",
"type": "LINUX_CONTAINER",
"environmentVariables": []
},
"source": {
"type": "S3",
"location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip"
},
"encryptionKey": "arn:aws:kms:region-ID:account-ID:alias/aws/s3",
"arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project"
}
}
```
For more information, see [Create a Build Project (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-project.html) in *AWS CLI Command Reference*.
### `create-report-group`
The following code example shows how to use `create-report-group`.
**AWS CLI**
**To create a report group in AWS CodeBuild.**
The following `create-report-group` example creates a new report group.
```
aws codebuild create-report-group \
--cli-input-json file://create-report-group-source.json
```
Contents of create-report-group-source.json:
```
{
"name": "cli-created-report-group",
"type": "TEST",
"exportConfig": {
"exportConfigType": "S3",
"s3Destination": {
"bucket": "amzn-s3-demo-bucket",
"path": "",
"packaging": "ZIP",
"encryptionDisabled": true
}
}
}
```
Output:
```
{
"reportGroup": {
"arn": "arn:aws:codebuild:::report-group/cli-created-report-group",
"name": "cli-created-report-group",
"type": "TEST",
"exportConfig": {
"exportConfigType": "S3",
"s3Destination": {
"bucket": "amzn-s3-demo-bucket",
"path": "",
"packaging": "ZIP",
"encryptionDisabled": true
}
},
"created": 1602020026.775,
"lastModified": 1602020026.775
}
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [CreateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-report-group.html) in *AWS CLI Command Reference*.
### `create-webhook`
The following code example shows how to use `create-webhook`.
**AWS CLI**
**To create webhook filters for an AWS CodeBuild project**
The following `create-webhook` example creates a webhook for a CodeBuild project named `my-project` that has two filter groups. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that match `^refs/heads/myBranch$`. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression `^refs/heads/myBranch$`.
```
aws codebuild create-webhook \
--project-name my-project \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]"
```
Output:
```
{
"webhook": {
"payloadUrl": "https://codebuild.us-west-2.amazonaws.com/webhooks?t=eyJlbmNyeXB0ZWREYXRhIjoiVVl5MGtoeGRwSzZFRXl2Wnh4bld1Z0tKZ291TVpQNEtFamQ3RDlDYWpRaGIreVFrdm9EQktIVk1NeHJEWEpmUDUrVUNOMUIyRHJRc1VxcHJ6QlNDSnljPSIsIml2UGFyYW1ldGVyU3BlYyI6InN4Tm1SeUt5MUhaUVRWbGciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&v=1",
"url": "https://api.github.com/repos/iversonic/codedeploy-sample/hooks/105190656",
"lastModifiedSecret": 1556311319.069,
"filterGroups": [
[
{
"type": "EVENT",
"pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED",
"excludeMatchedPattern": false
},
{
"type": "HEAD_REF",
"pattern": "refs/heads/myBranch$",
"excludeMatchedPattern": true
},
{
"type": "BASE_REF",
"pattern": "refs/heads/master$",
"excludeMatchedPattern": true
}
],
[
{
"type": "EVENT",
"pattern": "PUSH",
"excludeMatchedPattern": false
},
{
"type": "HEAD_REF",
"pattern": "refs/heads/myBranch$",
"excludeMatchedPattern": true
}
]
]
}
}
```
For more information, see [Filter GitHub Webhook Events (SDK)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-github-pull-request.html#sample-github-pull-request-filter-webhook-events-sdk) in the *AWS CodeBuild User Guide*.
+ For API details, see [CreateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-webhook.html) in *AWS CLI Command Reference*.
### `delete-build-batch`
The following code example shows how to use `delete-build-batch`.
**AWS CLI**
**To delete a batch build in AWS CodeBuild.**
The following `delete-build-batch` example deletes the specified batch build.
```
aws codebuild delete-build-batch \
--id :
```
Output:
```
{
"statusCode": "BATCH_DELETED",
"buildsDeleted": [
"arn:aws:codebuild:::build/:",
"arn:aws:codebuild:::build/:",
"arn:aws:codebuild:::build/:",
"arn:aws:codebuild:::build/:"
],
"buildsNotDeleted": []
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-build-batch.html) in *AWS CLI Command Reference*.
### `delete-project`
The following code example shows how to use `delete-project`.
**AWS CLI**
**To delete an AWS CodeBuild build project**
The following `delete-project` example deletes the specified CodeBuild build project.
```
aws codebuild delete-project --name my-project
```
This command produces no output.
For more information, see [Delete a Build Project (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-project.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-project.html) in *AWS CLI Command Reference*.
### `delete-report-group`
The following code example shows how to use `delete-report-group`.
**AWS CLI**
**To delete a report groups in AWS CodeBuild.**
The following `delete-report-group` example deletes the report group with the specified ARN.
```
aws codebuild delete-report-group \
--arn arn:aws:codebuild:::report-group/
```
This command produces no output.
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report-group.html) in *AWS CLI Command Reference*.
### `delete-report`
The following code example shows how to use `delete-report`.
**AWS CLI**
**To delete a report in AWS CodeBuild.**
The following `delete-report` example deletes the specified report.
```
aws codebuild delete-report \
--arn arn:aws:codebuild:::report/:
```
This command produces no output.
For more information, see [Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report.html) in *AWS CLI Command Reference*.
### `delete-source-credentials`
The following code example shows how to use `delete-source-credentials`.
**AWS CLI**
**To disconnect from a source provider and remove its access tokens.**
The following `delete-source-credentials` example disconnects from a source provider and removes its tokens. The ARN of source credentials used to connect to the source provider determines which source credentials.
```
aws codebuild delete-source-credentials --arn arn-of-your-credentials
```
Output:
```
{
"arn": "arn:aws:codebuild:your-region:your-account-id:token/your-server-type"
}
```
For more information, see [Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-source-credentials.html) in *AWS CLI Command Reference*.
### `delete-webhook`
The following code example shows how to use `delete-webhook`.
**AWS CLI**
**To delete a webhook filter from an AWS CodeBuild project**
The following `delete-webhook` example deletes a webhook from the specified CodeBuild project.
```
aws codebuild delete-webhook --project-name my-project
```
This command produces no output.
For more information, see [Stop Running Builds Automatically (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli-auto-stop) in the *AWS CodeBuild User Guide*.
+ For API details, see [DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-webhook.html) in *AWS CLI Command Reference*.
### `describe-code-coverages`
The following code example shows how to use `describe-code-coverages`.
**AWS CLI**
**To get detailed information about code coverage test results in AWS CodeBuild.**
The following `describe-code-coverages` example gets information about the code coverage test results in the specified report.
```
aws codebuild describe-code-coverages \
--report-arn arn:aws:codebuild:::report/:
```
Output:
```
{
"codeCoverages": [
{
"id": "20a0adcc-db13-4b66-804b-ecaf9f852855",
"reportARN": "arn:aws:codebuild::972506530580:report/:",
"filePath": "",
"lineCoveragePercentage": 83.33,
"linesCovered": 5,
"linesMissed": 1,
"branchCoveragePercentage": 50.0,
"branchesCovered": 1,
"branchesMissed": 1,
"expired": "2020-11-20T21:22:45+00:00"
},
{
"id": "0887162d-bf57-4cf1-a164-e432373d1a83",
"reportARN": "arn:aws:codebuild::972506530580:report/:",
"filePath": "",
"lineCoveragePercentage": 90.9,
"linesCovered": 10,
"linesMissed": 1,
"branchCoveragePercentage": 50.0,
"branchesCovered": 1,
"branchesMissed": 1,
"expired": "2020-11-20T21:22:45+00:00"
}
]
}
```
For more information, see [Code coverage reports](https://docs.aws.amazon.com/codebuild/latest/userguide/code-coverage-report.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DescribeCodeCoverages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-code-coverages.html) in *AWS CLI Command Reference*.
### `describe-test-cases`
The following code example shows how to use `describe-test-cases`.
**AWS CLI**
**To get detailed information about test cases in AWS CodeBuild.**
The following `describe-test-cases` example gets information about the test cases in the specified report.
```
aws codebuild describe-test-cases \
--report-arn arn:aws:codebuild:::report/:
```
Output:
```
{
"testCases": [
{
"reportArn": "arn:aws:codebuild:::report/:",
"testRawDataPath": "",
"prefix": "NUnit.Tests.Assemblies.MockTestFixture",
"name": "NUnit.Tests.Assemblies.MockTestFixture.NotRunnableTest",
"status": "ERROR",
"durationInNanoSeconds": 0,
"message": "No arguments were provided\n",
"expired": "2020-11-20T17:52:10+00:00"
},
{
"reportArn": "arn:aws:codebuild:::report/:",
"testRawDataPath": "",
"prefix": "NUnit.Tests.Assemblies.MockTestFixture",
"name": "NUnit.Tests.Assemblies.MockTestFixture.TestWithException",
"status": "ERROR",
"durationInNanoSeconds": 0,
"message": "System.ApplicationException : Intentional Exception\nat NUnit.Tests.Assemblies.MockTestFixture.MethodThrowsException()\nat NUnit.Tests.Assemblies.MockTestFixture.TestWithException()\n\n",
"expired": "2020-11-20T17:52:10+00:00"
}
]
}
```
For more information, see [Working with test reporting in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/test-reporting.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [DescribeTestCases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-test-cases.html) in *AWS CLI Command Reference*.
### `import-source-credentials`
The following code example shows how to use `import-source-credentials`.
**AWS CLI**
**Connect an AWS CodeBuild user to a source provider by importing credentials for the source provider.**
The following `import-source-credentials` example imports a token for a Bitbucket repository that uses BASIC\$1AUTH for its authentication type.
```
aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username
```
Output:
```
{
"arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket"
}
```
For more information, see [Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [ImportSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/import-source-credentials.html) in *AWS CLI Command Reference*.
### `invalidate-project-cache`
The following code example shows how to use `invalidate-project-cache`.
**AWS CLI**
**To reset the cache for an AWS CodeBuild build project.**
The following `invalidate-project-cache` example resets the cache for the specified CodeBuild project.
```
aws codebuild invalidate-project-cache --project-name my-project
```
This command produces no output.
For more information, see [Build Caching in CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [InvalidateProjectCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/invalidate-project-cache.html) in *AWS CLI Command Reference*.
### `list-build-batches-for-project`
The following code example shows how to use `list-build-batches-for-project`.
**AWS CLI**
**To list batch builds for a specific build project in AWS CodeBuild.**
The following `list-build-batches-for-project` example lists the CodeBuild batch builds for the specified project.
```
aws codebuild list-build-batches-for-project \
--project-name ""
```
Output:
```
{
"ids": [
":",
":"
]
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListBuildBatchesForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches-for-project.html) in *AWS CLI Command Reference*.
### `list-build-batches`
The following code example shows how to use `list-build-batches`.
**AWS CLI**
**To list batch builds in AWS CodeBuild.**
The following `list-build-batches` example lists the CodeBuild batch builds for the current account.
```
aws codebuild list-build-batches
```
Output:
```
{
"ids": [
":",
":"
]
}
```
For more information, see Batch builds in AWS CodeBuild )\$1\$1 in the *AWS CodeBuild User Guide*.
+ For API details, see [ListBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches.html) in *AWS CLI Command Reference*.
### `list-builds-for-project`
The following code example shows how to use `list-builds-for-project`.
**AWS CLI**
**To view a list of builds for an AWS CodeBuild build project.**
The following `list-builds-for-project` example lists the build IDs in descending order for the specified CodeBuild build project.
```
aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order DESCENDING
```
Output:
```
{
"ids": [
"codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-11111example",
"codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-22222example",
"codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-33333example",
"codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-44444example",
"codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-55555example"
]
}
```
For more information, see [View a List of Build IDs for a Build Project (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-builds-for-project.html#view-builds-for-project-cli) in the *AWS CodeBuild User Guide*
+ For API details, see [ListBuildsForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds-for-project.html) in *AWS CLI Command Reference*.
### `list-builds`
The following code example shows how to use `list-builds`.
**AWS CLI**
**To get a list of AWS CodeBuild builds IDs.**
The following `list-builds` example gets a list of CodeBuild IDs sorted in ascending order.
```
aws codebuild list-builds --sort-order ASCENDING
```
The output includes a `nextToken` value which indicates that there is more output available.
```
{
"nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==",
"ids": [
"codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE"
"codebuild-demo-project:84a7f3d1-d40e-4956-b4cf-7a9d4EXAMPLE"
... The full list of build IDs has been omitted for brevity ...
"codebuild-demo-project:931d0b72-bf6f-4040-a472-5c707EXAMPLE"
]
}
```
Run this command again and provide the `nextToken` value in the previous response as a parameter to get the next part of the output. Repeat until you don't receive a `nextToken` value in the response.
```
aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA==
```
Next part of the output:
```
{
"ids": [
"codebuild-demo-project:49015049-21cf-4b50-9708-df115EXAMPLE",
"codebuild-demo-project:543e7206-68a3-46d6-a4da-759abEXAMPLE",
... The full list of build IDs has been omitted for brevity ...
"codebuild-demo-project:c282f198-4582-4b38-bdc0-26f96EXAMPLE"
]
}
```
For more information, see [View a List of Build IDs (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-list.html) in the *AWS CodeBuild User Guide*
+ For API details, see [ListBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds.html) in *AWS CLI Command Reference*.
### `list-curated-environment-images`
The following code example shows how to use `list-curated-environment-images`.
**AWS CLI**
**To get a list of Docker images managed by AWS CodeBuild that you can use for your builds.**
The following `list-curated-environment-images` example lists the Docker images managed by CodeBuild that can be used for builds.:
```
aws codebuild list-curated-environment-images
```
Output:
```
{
"platforms": [
{
"platform": "AMAZON_LINUX",
"languages": [
{
"language": "JAVA",
"images": [
{
"description": "AWS ElasticBeanstalk - Java 7 Running on Amazon Linux 64bit v2.1.3",
"name": "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3",
"versions": [
"aws/codebuild/eb-java-7-amazonlinux-64:2.1.3-1.0.0"
]
},
{
"description": "AWS ElasticBeanstalk - Java 8 Running on Amazon Linux 64bit v2.1.3",
"name": "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3",
"versions": [
"aws/codebuild/eb-java-8-amazonlinux-64:2.1.3-1.0.0"
]
},
... LIST TRUNCATED FOR BREVITY ...
]
}
]
}
]
}
```
For more information, see [Docker Images Provided by CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) in the *AWS CodeBuild User Guide*
+ For API details, see [ListCuratedEnvironmentImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-curated-environment-images.html) in *AWS CLI Command Reference*.
### `list-projects`
The following code example shows how to use `list-projects`.
**AWS CLI**
**To get a list of AWS CodeBuild build project names.**
The following `list-projects` example gets a list of CodeBuild build projects sorted by name in ascending order.
```
aws codebuild list-projects --sort-by NAME --sort-order ASCENDING
```
The output includes a `nextToken` value which indicates that there is more output available.
```
{
"nextToken": "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=",
"projects": [
"codebuild-demo-project",
"codebuild-demo-project2",
... The full list of build project names has been omitted for brevity ...
"codebuild-demo-project99"
]
}
```
Run this command again and provide the `nextToken` value from the previous response as a parameter to get the next part of the output. Repeat until you don't receive a `nextToken` value in the response.
```
aws codebuild list-projects --sort-by NAME --sort-order ASCENDING --next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=
{
"projects": [
"codebuild-demo-project100",
"codebuild-demo-project101",
... The full list of build project names has been omitted for brevity ...
"codebuild-demo-project122"
]
}
```
For more information, see [View a List of Build Project Names (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-list.html#view-project-list-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-projects.html) in *AWS CLI Command Reference*.
### `list-report-groups`
The following code example shows how to use `list-report-groups`.
**AWS CLI**
**To get a list of the report group ARNs in AWS CodeBuild.**
The following `list-report-groups` example retrieves the report group ARNs for the account in the region.
```
aws codebuild list-report-groups
```
Output:
```
{
"reportGroups": [
"arn:aws:codebuild:::report-group/report-group-1",
"arn:aws:codebuild:::report-group/report-group-2",
"arn:aws:codebuild:::report-group/report-group-3"
]
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-report-groups.html) in *AWS CLI Command Reference*.
### `list-reports-for-report-group`
The following code example shows how to use `list-reports-for-report-group`.
**AWS CLI**
**To get a list of the reports in a report group in AWS CodeBuild.**
The following `list-report-for-report-groups` example retrieves the reports in the specified report group for the account in the region.
```
aws codebuild list-reports-for-report-group \
--report-group-arn arn:aws:codebuild:::report-group/
```
Output:
```
{
"reports": [
"arn:aws:codebuild:::report/report-1",
"arn:aws:codebuild:::report/report-2",
"arn:aws:codebuild:::report/report-3"
]
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListReportsForReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports-for-report-group.html) in *AWS CLI Command Reference*.
### `list-reports`
The following code example shows how to use `list-reports`.
**AWS CLI**
**To get a list of the reports for the current account in AWS CodeBuild.**
The following `list-reports` example retrieves the ARNs of the reports for the current account.
```
aws codebuild list-reports
```
Output:
```
{
"reports": [
"arn:aws:codebuild:::report/:",
"arn:aws:codebuild:::report/:",
"arn:aws:codebuild:::report/:"
]
}
```
For more information, see [Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports.html) in *AWS CLI Command Reference*.
### `list-shared-projects`
The following code example shows how to use `list-shared-projects`.
**AWS CLI**
**To list the shared project in AWS CodeBuild.**
The following `list-shared-projects` example lists the CodeBuild shared projects that are available to the current account.
```
aws codebuild list-shared-projects
```
Output:
```
{
"projects": [
"arn:aws:codebuild:::project/",
"arn:aws:codebuild:::project/"
]
}
```
For more information, see [Working with shared projects](https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListSharedProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-projects.html) in *AWS CLI Command Reference*.
### `list-shared-report-groups`
The following code example shows how to use `list-shared-report-groups`.
**AWS CLI**
**To get a list of the shared report group ARNs in AWS CodeBuild.**
The following `list-shared-report-groups` example retrieves the report group ARNs for the account in the region.
```
aws codebuild list-shared-report-groups
```
Output:
```
{
"reportGroups": [
"arn:aws:codebuild:::report-group/report-group-1",
"arn:aws:codebuild:::report-group/report-group-2",
"arn:aws:codebuild:::report-group/report-group-3"
]
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListSharedReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-report-groups.html) in *AWS CLI Command Reference*.
### `list-source-credentials`
The following code example shows how to use `list-source-credentials`.
**AWS CLI**
**To view a list of sourceCredentialsObjects**
The following `list-source-credentials` example lists tokens for an AWS account connected to one Bitbucket account and one GitHub account. Each `sourceCredentialsInfos` object in the response contains connected source credentials information.
```
aws codebuild list-source-credentials
```
Output:
```
{
"sourceCredentialsInfos": [
{
"serverType": "BITBUCKET",
"arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket",
"authType": "BASIC_AUTH"
},
{
"serverType": "GITHUB",
"arn": "arn:aws:codebuild:us-west-2:123456789012:token/github",
"authType": "OAUTH"
}
]
}
```
For more information, see [Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [ListSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-source-credentials.html) in *AWS CLI Command Reference*.
### `retry-build-batch`
The following code example shows how to use `retry-build-batch`.
**AWS CLI**
**To retry a failed batch build in AWS CodeBuild.**
The following `retry-build-batch` example restarts the specified batch build.
```
aws codebuild retry-build-batch \
--id :
```
Output:
```
{
"buildBatch": {
"id": ":",
"arn": "arn:aws:codebuild:::build-batch/:",
"startTime": "2020-10-21T17:26:23.099000+00:00",
"currentPhase": "SUBMITTED",
"buildBatchStatus": "IN_PROGRESS",
"resolvedSourceVersion": "3a9e11cb419e8fff14b03883dc4e64f6155aaa7e",
"projectName": "",
"phases": [
{
"phaseType": "SUBMITTED",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-10-21T17:26:23.099000+00:00",
"endTime": "2020-10-21T17:26:23.457000+00:00",
"durationInSeconds": 0
},
{
"phaseType": "DOWNLOAD_BATCHSPEC",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-10-21T17:26:23.457000+00:00",
"endTime": "2020-10-21T17:26:54.902000+00:00",
"durationInSeconds": 31
},
{
"phaseType": "IN_PROGRESS",
"phaseStatus": "CLIENT_ERROR",
"startTime": "2020-10-21T17:26:54.902000+00:00",
"endTime": "2020-10-21T17:28:16.060000+00:00",
"durationInSeconds": 81
},
{
"phaseType": "FAILED",
"phaseStatus": "RETRY",
"startTime": "2020-10-21T17:28:16.060000+00:00",
"endTime": "2020-10-21T17:29:39.709000+00:00",
"durationInSeconds": 83
},
{
"phaseType": "SUBMITTED",
"startTime": "2020-10-21T17:29:39.709000+00:00"
}
],
"source": {
"type": "GITHUB",
"location": "https://github.com/strohm-a/-graph.git",
"gitCloneDepth": 1,
"gitSubmodulesConfig": {
"fetchSubmodules": false
},
"reportBuildStatus": false,
"insecureSsl": false
},
"secondarySources": [],
"secondarySourceVersions": [],
"artifacts": {
"location": ""
},
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [],
"privilegedMode": false,
"imagePullCredentialsType": "CODEBUILD"
},
"logConfig": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED",
"encryptionDisabled": false
}
},
"buildTimeoutInMinutes": 60,
"queuedTimeoutInMinutes": 480,
"complete": false,
"initiator": "",
"encryptionKey": "arn:aws:kms:::alias/aws/s3",
"buildBatchNumber": 4,
"buildBatchConfig": {
"serviceRole": "arn:aws:iam:::role/service-role/",
"restrictions": {
"maximumBuildsAllowed": 100
},
"timeoutInMins": 480
},
"buildGroups": [
{
"identifier": "DOWNLOAD_SOURCE",
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T17:26:23.889000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "DOWNLOAD_SOURCE"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_small",
"dependsOn": [],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T17:26:55.115000+00:00",
"buildStatus": "FAILED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "linux_small"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_medium",
"dependsOn": [
"linux_small"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T17:26:54.594000+00:00",
"buildStatus": "STOPPED"
}
},
{
"identifier": "linux_large",
"dependsOn": [
"linux_medium"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T17:26:54.701000+00:00",
"buildStatus": "STOPPED"
}
}
]
}
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [RetryBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build-batch.html) in *AWS CLI Command Reference*.
### `retry-build`
The following code example shows how to use `retry-build`.
**AWS CLI**
**To retry a failed build in AWS CodeBuild.**
The following `retry-build` example restarts the specified build.
```
aws codebuild retry-build \
--id :
```
Output:
```
{
"build": {
"id": ":",
"arn": "arn:aws:codebuild:::build/:",
"buildNumber": 9,
"startTime": "2020-10-21T17:51:38.161000+00:00",
"currentPhase": "QUEUED",
"buildStatus": "IN_PROGRESS",
"projectName": "",
"phases": [
{
"phaseType": "SUBMITTED",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-10-21T17:51:38.161000+00:00",
"endTime": "2020-10-21T17:51:38.210000+00:00",
"durationInSeconds": 0
},
{
"phaseType": "QUEUED",
"startTime": "2020-10-21T17:51:38.210000+00:00"
}
],
"source": {
"type": "GITHUB",
"location": "",
"gitCloneDepth": 1,
"gitSubmodulesConfig": {
"fetchSubmodules": false
},
"reportBuildStatus": false,
"insecureSsl": false
},
"secondarySources": [],
"secondarySourceVersions": [],
"artifacts": {
"location": ""
},
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [],
"privilegedMode": false,
"imagePullCredentialsType": "CODEBUILD"
},
"serviceRole": "arn:aws:iam:::role/service-role/",
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=#logEvent:group=null;stream=null",
"cloudWatchLogsArn": "arn:aws:logs:::log-group:null:log-stream:null",
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED",
"encryptionDisabled": false
}
},
"timeoutInMinutes": 60,
"queuedTimeoutInMinutes": 480,
"buildComplete": false,
"initiator": "",
"encryptionKey": "arn:aws:kms:::alias/aws/s3"
}
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [RetryBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build.html) in *AWS CLI Command Reference*.
### `start-build-batch`
The following code example shows how to use `start-build-batch`.
**AWS CLI**
**To start a batch build in AWS CodeBuild.**
The following `start-build-batch` example starts a batch build of the specified project.
```
aws codebuild start-build-batch \
--project-name
```
Output:
```
{
"buildBatch": {
"id": ":",
"arn": "arn:aws:codebuild:::build-batch/:",
"startTime": "2020-10-21T16:54:24.740000+00:00",
"currentPhase": "SUBMITTED",
"buildBatchStatus": "IN_PROGRESS",
"projectName": "",
"source": {
"type": "GITHUB",
"location": "",
"gitCloneDepth": 1,
"gitSubmodulesConfig": {
"fetchSubmodules": false
},
"reportBuildStatus": false,
"insecureSsl": false
},
"secondarySources": [],
"secondarySourceVersions": [],
"artifacts": {
"location": ""
},
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [],
"privilegedMode": false,
"imagePullCredentialsType": "CODEBUILD"
},
"logConfig": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED",
"encryptionDisabled": false
}
},
"buildTimeoutInMinutes": 60,
"queuedTimeoutInMinutes": 480,
"complete": false,
"initiator": "",
"encryptionKey": "arn:aws:kms:::alias/aws/s3",
"buildBatchNumber": 3,
"buildBatchConfig": {
"serviceRole": "arn:aws:iam:::role/service-role/",
"restrictions": {
"maximumBuildsAllowed": 100
},
"timeoutInMins": 480
}
}
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [StartBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build-batch.html) in *AWS CLI Command Reference*.
### `start-build`
The following code example shows how to use `start-build`.
**AWS CLI**
**To start running a build of an AWS CodeBuild build project.**
The following `start-build` example starts a build for the specified CodeBuild project. The build overrides both the project's setting for the number of minutes the build is allowed to be queued before it times out and the project's artifact settings.
```
aws codebuild start-build \
--project-name "my-demo-project" \
--queued-timeout-in-minutes-override 5 \
--artifacts-override {"\"type\": \"S3\",\"location\": \"arn:aws:s3:::artifacts-override\",\"overrideArtifactName\":true"}
```
Output:
```
{
"build": {
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"buildStatus": "IN_PROGRESS",
"buildComplete": false,
"projectName": "my-demo-project",
"timeoutInMinutes": 60,
"source": {
"insecureSsl": false,
"type": "S3",
"location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip"
},
"queuedTimeoutInMinutes": 5,
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"currentPhase": "QUEUED",
"startTime": 1556905683.568,
"environment": {
"computeType": "BUILD_GENERAL1_MEDIUM",
"environmentVariables": [],
"type": "LINUX_CONTAINER",
"privilegedMode": false,
"image": "aws/codebuild/standard:1.0",
"imagePullCredentialsType": "CODEBUILD"
},
"phases": [
{
"phaseStatus": "SUCCEEDED",
"startTime": 1556905683.568,
"phaseType": "SUBMITTED",
"durationInSeconds": 0,
"endTime": 1556905684.524
},
{
"startTime": 1556905684.524,
"phaseType": "QUEUED"
}
],
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=null;stream=null"
},
"artifacts": {
"encryptionDisabled": false,
"location": "arn:aws:s3:::artifacts-override/my-demo-project",
"overrideArtifactName": true
},
"cache": {
"type": "NO_CACHE"
},
"id": "my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE",
"initiator": "my-aws-account-name",
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE"
}
}
```
For more information, see [Run a Build (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [StartBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build.html) in *AWS CLI Command Reference*.
### `stop-build-batch`
The following code example shows how to use `stop-build-batch`.
**AWS CLI**
**To stop an in-progress batch build in AWS CodeBuild.**
The following `stop-build-batch` example stops the specified batch build.
```
aws codebuild stop-build-batch \
--id :
```
Output:
```
{
"buildBatch": {
"id": ":",
"arn": "arn:aws:codebuild:::build-batch/:",
"startTime": "2020-10-21T16:54:24.740000+00:00",
"endTime": "2020-10-21T16:56:05.152000+00:00",
"currentPhase": "STOPPED",
"buildBatchStatus": "STOPPED",
"resolvedSourceVersion": "aef7744ed069c51098e15c360f4102cd2cd1ad64",
"projectName": "",
"phases": [
{
"phaseType": "SUBMITTED",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-10-21T16:54:24.740000+00:00",
"endTime": "2020-10-21T16:54:25.039000+00:00",
"durationInSeconds": 0
},
{
"phaseType": "DOWNLOAD_BATCHSPEC",
"phaseStatus": "SUCCEEDED",
"startTime": "2020-10-21T16:54:25.039000+00:00",
"endTime": "2020-10-21T16:54:56.583000+00:00",
"durationInSeconds": 31
},
{
"phaseType": "IN_PROGRESS",
"phaseStatus": "STOPPED",
"startTime": "2020-10-21T16:54:56.583000+00:00",
"endTime": "2020-10-21T16:56:05.152000+00:00",
"durationInSeconds": 68
},
{
"phaseType": "STOPPED",
"startTime": "2020-10-21T16:56:05.152000+00:00"
}
],
"source": {
"type": "GITHUB",
"location": "",
"gitCloneDepth": 1,
"gitSubmodulesConfig": {
"fetchSubmodules": false
},
"reportBuildStatus": false,
"insecureSsl": false
},
"secondarySources": [],
"secondarySourceVersions": [],
"artifacts": {
"location": ""
},
"secondaryArtifacts": [],
"cache": {
"type": "NO_CACHE"
},
"environment": {
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/amazonlinux2-x86_64-standard:3.0",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [],
"privilegedMode": false,
"imagePullCredentialsType": "CODEBUILD"
},
"logConfig": {
"cloudWatchLogs": {
"status": "ENABLED"
},
"s3Logs": {
"status": "DISABLED",
"encryptionDisabled": false
}
},
"buildTimeoutInMinutes": 60,
"queuedTimeoutInMinutes": 480,
"complete": true,
"initiator": "Strohm",
"encryptionKey": "arn:aws:kms:::alias/aws/s3",
"buildBatchNumber": 3,
"buildBatchConfig": {
"serviceRole": "arn:aws:iam:::role/service-role/",
"restrictions": {
"maximumBuildsAllowed": 100
},
"timeoutInMins": 480
},
"buildGroups": [
{
"identifier": "DOWNLOAD_SOURCE",
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T16:54:25.468000+00:00",
"buildStatus": "SUCCEEDED",
"primaryArtifact": {
"type": "no_artifacts",
"identifier": "DOWNLOAD_SOURCE"
},
"secondaryArtifacts": []
}
},
{
"identifier": "linux_small",
"dependsOn": [],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T16:54:56.833000+00:00",
"buildStatus": "IN_PROGRESS"
}
},
{
"identifier": "linux_medium",
"dependsOn": [
"linux_small"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T16:54:56.211000+00:00",
"buildStatus": "PENDING"
}
},
{
"identifier": "linux_large",
"dependsOn": [
"linux_medium"
],
"ignoreFailure": false,
"currentBuildSummary": {
"arn": "arn:aws:codebuild:::build/:",
"requestedOn": "2020-10-21T16:54:56.330000+00:00",
"buildStatus": "PENDING"
}
}
]
}
}
```
For more information, see [Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [StopBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build-batch.html) in *AWS CLI Command Reference*.
### `stop-build`
The following code example shows how to use `stop-build`.
**AWS CLI**
**To stop a build of an AWS CodeBuild build project.**
The following `stop-build` example stops the specified CodeBuild build.
```
aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE
```
Output:
```
{
"build": {
"startTime": 1556906956.318,
"initiator": "my-aws-account-name",
"projectName": "my-demo-project",
"currentPhase": "COMPLETED",
"cache": {
"type": "NO_CACHE"
},
"source": {
"insecureSsl": false,
"location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip",
"type": "S3"
},
"id": "my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
"endTime": 1556906974.781,
"phases": [
{
"durationInSeconds": 0,
"phaseType": "SUBMITTED",
"endTime": 1556906956.935,
"phaseStatus": "SUCCEEDED",
"startTime": 1556906956.318
},
{
"durationInSeconds": 1,
"phaseType": "QUEUED",
"endTime": 1556906958.272,
"phaseStatus": "SUCCEEDED",
"startTime": 1556906956.935
},
{
"phaseType": "PROVISIONING",
"phaseStatus": "SUCCEEDED",
"durationInSeconds": 14,
"contexts": [
{
"message": "",
"statusCode": ""
}
],
"endTime": 1556906972.847,
"startTime": 1556906958.272
},
{
"phaseType": "DOWNLOAD_SOURCE",
"phaseStatus": "SUCCEEDED",
"durationInSeconds": 0,
"contexts": [
{
"message": "",
"statusCode": ""
}
],
"endTime": 1556906973.552,
"startTime": 1556906972.847
},
{
"phaseType": "INSTALL",
"phaseStatus": "SUCCEEDED",
"durationInSeconds": 0,
"contexts": [
{
"message": "",
"statusCode": ""
}
],
"endTime": 1556906973.75,
"startTime": 1556906973.552
},
{
"phaseType": "PRE_BUILD",
"phaseStatus": "SUCCEEDED",
"durationInSeconds": 0,
"contexts": [
{
"message": "",
"statusCode": ""
}
],
"endTime": 1556906973.937,
"startTime": 1556906973.75
},
{
"durationInSeconds": 0,
"phaseType": "BUILD",
"endTime": 1556906974.781,
"phaseStatus": "STOPPED",
"startTime": 1556906973.937
},
{
"phaseType": "COMPLETED",
"startTime": 1556906974.781
}
],
"artifacts": {
"location": "arn:aws:s3:::artifacts-override/my-demo-project",
"encryptionDisabled": false,
"overrideArtifactName": true
},
"buildComplete": true,
"buildStatus": "STOPPED",
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"queuedTimeoutInMinutes": 5,
"timeoutInMinutes": 60,
"environment": {
"type": "LINUX_CONTAINER",
"environmentVariables": [],
"computeType": "BUILD_GENERAL1_MEDIUM",
"privilegedMode": false,
"image": "aws/codebuild/standard:1.0",
"imagePullCredentialsType": "CODEBUILD"
},
"logs": {
"streamName": "1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-demo-project;stream=1a2b3c4d-5678-90ab-cdef-11111EXAMPLE",
"groupName": "/aws/codebuild/my-demo-project"
},
"arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE"
}
}
```
For more information, see [Stop a Build (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/stop-build.html#stop-build-cli) in the *AWS CodeBuild User Guide*.
+ For API details, see [StopBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build.html) in *AWS CLI Command Reference*.
### `update-project`
The following code example shows how to use `update-project`.
**AWS CLI**
**To change an AWS CodeBuild build project's settings.**
The following `update-project` example changes the settings of the specified CodeBuild build project named my-demo-project.
```
aws codebuild update-project --name "my-demo-project" \
--description "This project is updated" \
--source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip\"}" \
--artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket-2\""} \
--environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \
--service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role"
```
The output displays the updated settings.
```
{
"project": {
"arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project",
"environment": {
"privilegedMode": false,
"environmentVariables": [],
"type": "LINUX_CONTAINER",
"image": "aws/codebuild/standard:1.0",
"computeType": "BUILD_GENERAL1_MEDIUM",
"imagePullCredentialsType": "CODEBUILD"
},
"queuedTimeoutInMinutes": 480,
"description": "This project is updated",
"artifacts": {
"packaging": "NONE",
"name": "my-demo-project",
"type": "S3",
"namespaceType": "NONE",
"encryptionDisabled": false,
"location": "codebuild-us-west-2-123456789012-output-bucket-2"
},
"encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3",
"badge": {
"badgeEnabled": false
},
"serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role",
"lastModified": 1556840545.967,
"tags": [],
"timeoutInMinutes": 60,
"created": 1556839783.274,
"name": "my-demo-project",
"cache": {
"type": "NO_CACHE"
},
"source": {
"type": "S3",
"insecureSsl": false,
"location": "codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip"
}
}
}
```
For more information, see [Change a Build Project's Settings (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli) in the *AWS CodeBuild User Guide*
+ For API details, see [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-project.html) in *AWS CLI Command Reference*.
### `update-report-group`
The following code example shows how to use `update-report-group`.
**AWS CLI**
**To update a report group in AWS CodeBuild.**
The following `update-report-group` example changes the export type of the report group to "NO\$1EXPORT".
```
aws codebuild update-report-group \
--arn arn:aws:codebuild:::report-group/cli-created-report-group \
--export-config="exportConfigType=NO_EXPORT"
```
Output:
```
{
"reportGroup": {
"arn": "arn:aws:codebuild:::report-group/cli-created-report-group",
"name": "cli-created-report-group",
"type": "TEST",
"exportConfig": {
"exportConfigType": "NO_EXPORT"
},
"created": 1602020686.009,
"lastModified": 1602021033.454,
"tags": []
}
}
```
For more information, see [Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html) in the *AWS CodeBuild User Guide*.
+ For API details, see [UpdateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-report-group.html) in *AWS CLI Command Reference*.
### `update-webhook`
The following code example shows how to use `update-webhook`.
**AWS CLI**
**To update the webhook for an AWS CodeBuild project**
The following `update-webhook` example updates a webhook for the specified CodeBuild project with two filter groups. The `--rotate-secret` parameter specifies that GitHub rotate the project's secret key every time a code change triggers a build. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression `^refs/heads/master$` and head references that match `^refs/heads/myBranch$`. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression `^refs/heads/myBranch$`.
```
aws codebuild update-webhook \
--project-name Project2 \
--rotate-secret \
--filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]"
```
Output:
```
{
"webhook": {
"filterGroups": [
[
{
"pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED",
"type": "EVENT"
},
{
"excludeMatchedPattern": true,
"pattern": "refs/heads/myBranch$",
"type": "HEAD_REF"
},
{
"excludeMatchedPattern": true,
"pattern": "refs/heads/master$",
"type": "BASE_REF"
}
],
[
{
"pattern": "PUSH",
"type": "EVENT"
},
{
"excludeMatchedPattern": true,
"pattern": "refs/heads/myBranch$",
"type": "HEAD_REF"
}
]
],
"lastModifiedSecret": 1556312220.133
}
}
```
For more information, see [Change a Build Project's Settings (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli) in the *AWS CodeBuild User Guide*
+ For API details, see [UpdateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-webhook.html) in *AWS CLI Command Reference*.
# CodeCommit examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodeCommit.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `associate-approval-rule-template-with-repository`
The following code example shows how to use `associate-approval-rule-template-with-repository`.
**AWS CLI**
**To associate an approval rule template with a repository**
The following `associate-approval-rule-template-with-repository` example associates the specified approval rule template with a repository named `MyDemoRepo`.
```
aws codecommit associate-approval-rule-template-with-repository \
--repository-name MyDemoRepo \
--approval-rule-template-name 2-approver-rule-for-main
```
This command produces no output.
For more information, see [Associate an Approval Rule Template with a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#associate-template-repository) in the *AWS CodeCommit User Guide*.
+ For API details, see [AssociateApprovalRuleTemplateWithRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/associate-approval-rule-template-with-repository.html) in *AWS CLI Command Reference*.
### `batch-associate-approval-rule-template-with-repositories`
The following code example shows how to use `batch-associate-approval-rule-template-with-repositories`.
**AWS CLI**
**To associate an approval rule template with multiple repositories in a single operation**
The following `batch-associate-approval-rule-template-with-repositories` example associates the specified approval rule template with repositories named `MyDemoRepo` and `MyOtherDemoRepo`.
Note: Approval rule templates are specific to the AWS Region where they are created. They can only be associated with repositories in that AWS Region.
```
aws codecommit batch-associate-approval-rule-template-with-repositories \
--repository-names MyDemoRepo, MyOtherDemoRepo \
--approval-rule-template-name 2-approver-rule-for-main
```
Output:
```
{
"associatedRepositoryNames": [
"MyDemoRepo",
"MyOtherDemoRepo"
],
"errors": []
}
```
For more information, see [Associate an Approval Rule Template with a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#batch-associate-template-repositories) in the *AWS CodeCommit User Guide*.
+ For API details, see [BatchAssociateApprovalRuleTemplateWithRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-associate-approval-rule-template-with-repositories.html) in *AWS CLI Command Reference*.
### `batch-describe-merge-conflicts`
The following code example shows how to use `batch-describe-merge-conflicts`.
**AWS CLI**
**To get information about merge conflicts in all files or a subset of files in a merge between two commit specifiers**
The following `batch-describe-merge-conflicts` example determines the merge conflicts for merging a source branch named `feature-randomizationfeature` with a destination branch named `main` using the `THREE_WAY_MERGE` strategy in a repository named `MyDemoRepo`.
```
aws codecommit batch-describe-merge-conflicts \
--source-commit-specifier feature-randomizationfeature \
--destination-commit-specifier main \
--merge-option THREE_WAY_MERGE \
--repository-name MyDemoRepo
```
Output:
```
{
"conflicts": [
{
"conflictMetadata": {
"filePath": "readme.md",
"fileSizes": {
"source": 139,
"destination": 230,
"base": 85
},
"fileModes": {
"source": "NORMAL",
"destination": "NORMAL",
"base": "NORMAL"
},
"objectTypes": {
"source": "FILE",
"destination": "FILE",
"base": "FILE"
},
"numberOfConflicts": 1,
"isBinaryFile": {
"source": false,
"destination": false,
"base": false
},
"contentConflict": true,
"fileModeConflict": false,
"objectTypeConflict": false,
"mergeOperations": {
"source": "M",
"destination": "M"
}
},
"mergeHunks": [
{
"isConflict": true,
"source": {
"startLine": 0,
"endLine": 3,
"hunkContent": "VGhpcyBpEXAMPLE=="
},
"destination": {
"startLine": 0,
"endLine": 1,
"hunkContent": "VXNlIHRoEXAMPLE="
}
}
]
}
],
"errors": [],
"destinationCommitId": "86958e0aEXAMPLE",
"sourceCommitId": "6ccd57fdEXAMPLE",
"baseCommitId": "767b6958EXAMPLE"
}
```
For more information, see [Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts) in the *AWS CodeCommit User Guide*.
+ For API details, see [BatchDescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-describe-merge-conflicts.html) in *AWS CLI Command Reference*.
### `batch-disassociate-approval-rule-template-from-repositories`
The following code example shows how to use `batch-disassociate-approval-rule-template-from-repositories`.
**AWS CLI**
**To disassociate an approval rule template from multiple repositories in a single operation**
The following `batch-disassociate-approval-rule-template-from-repositories` example disassociates the specified approval rule template from repositories named `MyDemoRepo` and `MyOtherDemoRepo`.
```
aws codecommit batch-disassociate-approval-rule-template-from-repositories \
--repository-names MyDemoRepo, MyOtherDemoRepo \
--approval-rule-template-name 1-approval-rule-for-all pull requests
```
Output:
```
{
"disassociatedRepositoryNames": [
"MyDemoRepo",
"MyOtherDemoRepo"
],
"errors": []
}
```
For more information, see [Disassociate an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#batch-disassociate-template) in the *AWS CodeCommit User Guide*.
+ For API details, see [BatchDisassociateApprovalRuleTemplateFromRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-disassociate-approval-rule-template-from-repositories.html) in *AWS CLI Command Reference*.
### `batch-get-commits`
The following code example shows how to use `batch-get-commits`.
**AWS CLI**
**To view information about multiple commits**
The following `batch-get-commits` example displays details about the specified commits.
```
aws codecommit batch-get-commits \
--repository-name MyDemoRepo \
--commit-ids 317f8570EXAMPLE 4c925148EXAMPLE
```
Output:
```
{
"commits": [
{
"additionalData": "",
"committer": {
"date": "1508280564 -0800",
"name": "Mary Major",
"email": "mary_major@example.com"
},
"author": {
"date": "1508280564 -0800",
"name": "Mary Major",
"email": "mary_major@example.com"
},
"commitId": "317f8570EXAMPLE",
"treeId": "1f330709EXAMPLE",
"parents": [
"6e147360EXAMPLE"
],
"message": "Change variable name and add new response element"
},
{
"additionalData": "",
"committer": {
"date": "1508280542 -0800",
"name": "Li Juan",
"email": "li_juan@example.com"
},
"author": {
"date": "1508280542 -0800",
"name": "Li Juan",
"email": "li_juan@example.com"
},
"commitId": "4c925148EXAMPLE",
"treeId": "1f330709EXAMPLE",
"parents": [
"317f8570EXAMPLE"
],
"message": "Added new class"
}
}
```
For more information, see [View Commit Details](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-batch-get-commits) in the *AWS CodeCommit User Guide*.
+ For API details, see [BatchGetCommits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-commits.html) in *AWS CLI Command Reference*.
### `batch-get-repositories`
The following code example shows how to use `batch-get-repositories`.
**AWS CLI**
**To view details about multiple repositories**
This example shows details about multiple AWS CodeCommit repositories.
```
aws codecommit batch-get-repositories \
--repository-names MyDemoRepo MyOtherDemoRepo
```
Output:
```
{
"repositoriesNotFound": [],
"repositories": [
{
"creationDate": 1429203623.625,
"defaultBranch": "main",
"repositoryName": "MyDemoRepo",
"cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo",
"lastModifiedDate": 1430783812.0869999,
"repositoryDescription": "My demonstration repository",
"cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo",
"repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
"Arn": "arn:aws:codecommit:us-east-2:111111111111:MyDemoRepo"
"accountId": "111111111111"
},
{
"creationDate": 1429203623.627,
"defaultBranch": "main",
"repositoryName": "MyOtherDemoRepo",
"cloneUrlSsh": "ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo",
"lastModifiedDate": 1430783812.0889999,
"repositoryDescription": "My other demonstration repository",
"cloneUrlHttp": "https://codecommit.us-east-2.amazonaws.com/v1/repos/MyOtherDemoRepo",
"repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE",
"Arn": "arn:aws:codecommit:us-east-2:111111111111:MyOtherDemoRepo"
"accountId": "111111111111"
}
],
"repositoriesNotFound": []
}
```
+ For API details, see [BatchGetRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-repositories.html) in *AWS CLI Command Reference*.
### `create-approval-rule-template`
The following code example shows how to use `create-approval-rule-template`.
**AWS CLI**
**To create an approval rule template**
The following `create-approval-rule-template` example creates an approval rule template named `2-approver-rule-for-main ``. The template requires two users who assume the role of ``CodeCommitReview` to approve any pull request before it can be merged to the `main` branch.
```
aws codecommit create-approval-rule-template \
--approval-rule-template-name 2-approver-rule-for-main \
--approval-rule-template-description "Requires two developers from the team to approve the pull request if the destination branch is main" \
--approval-rule-template-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"
```
Output:
```
{
"approvalRuleTemplate": {
"approvalRuleTemplateName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
"approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"approvalRuleTemplateDescription": "Requires two developers from the team to approve the pull request if the destination branch is main",
"lastModifiedDate": 1571356106.936,
"ruleContentSha256": "4711b576EXAMPLE"
}
}
```
For more information, see [Create an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-template.html#create-template-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [CreateApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-approval-rule-template.html) in *AWS CLI Command Reference*.
### `create-branch`
The following code example shows how to use `create-branch`.
**AWS CLI**
**To create a branch**
This example creates a branch in an AWS CodeCommit repository. This command produces output only if there are errors.
Command:
```
aws codecommit create-branch --repository-name MyDemoRepo --branch-name MyNewBranch --commit-id 317f8570EXAMPLE
```
Output:
```
None.
```
+ For API details, see [CreateBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-branch.html) in *AWS CLI Command Reference*.
### `create-commit`
The following code example shows how to use `create-commit`.
**AWS CLI**
**To create a commit**
The following `create-commit` example demonstrates how to create an initial commit for a repository that adds a `readme.md` file to a repository named `MyDemoRepo` in the `main` branch.
```
aws codecommit create-commit \
--repository-name MyDemoRepo \
--branch-name main \
--put-files "filePath=readme.md,fileContent='Welcome to our team repository.'"
```
Output:
```
{
"filesAdded": [
{
"blobId": "5e1c309d-EXAMPLE",
"absolutePath": "readme.md",
"fileMode": "NORMAL"
}
],
"commitId": "4df8b524-EXAMPLE",
"treeId": "55b57003-EXAMPLE",
"filesDeleted": [],
"filesUpdated": []
}
```
For more information, see [Create a Commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-commit.html#how-to-create-commit-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [CreateCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-commit.html) in *AWS CLI Command Reference*.
### `create-pull-request-approval-rule`
The following code example shows how to use `create-pull-request-approval-rule`.
**AWS CLI**
**To create an approval rule for a pull request**
The following `create-pull-request-approval-rule` example creates an approval rule named `Require two approved approvers` for the specified pull request. The rule specifies that two approvals are required from an approval pool. The pool includes all users who access CodeCommit by assuming the role of `CodeCommitReview` in the `123456789012` AWS account. It also includes either an IAM user or federated user named `Nikhil_Jayashankar` from the same AWS account.
```
aws codecommit create-pull-request-approval-rule \
--approval-rule-name "Require two approved approvers" \
--approval-rule-content "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"
```
Output:
```
{
"approvalRule": {
"approvalRuleName": "Require two approved approvers",
"lastModifiedDate": 1570752871.932,
"ruleContentSha256": "7c44e6ebEXAMPLE",
"creationDate": 1570752871.932,
"approvalRuleId": "aac33506-EXAMPLE",
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"CodeCommitApprovers:123456789012:Nikhil_Jayashankar\", \"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major"
}
}
```
For more information, see [Create an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-pull-request-approval-rule.html#how-to-create-pull-request-approval-rule-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [CreatePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request-approval-rule.html) in *AWS CLI Command Reference*.
### `create-pull-request`
The following code example shows how to use `create-pull-request`.
**AWS CLI**
**To create a pull request**
The following `create-pull-request` example creates a pull request named 'Pronunciation difficulty analyzer' with a description of 'Please review these changes by Tuesday' that targets the 'jane-branch' source branch and is to be merged to the default branch 'main' in an AWS CodeCommit repository named 'MyDemoRepo'.
```
aws codecommit create-pull-request \
--title "My Pull Request" \
--description "Please review these changes by Tuesday" \
--client-request-token 123Example \
--targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"originApprovalRuleTemplate": {
"approvalRuleTemplateId": "dd3d22fe-EXAMPLE",
"approvalRuleTemplateName": "2-approver-rule-for-main"
},
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::111111111111:user/Jane_Doe",
"description": "Please review these changes by Tuesday",
"title": "Pronunciation difficulty analyzer",
"pullRequestTargets": [
{
"destinationCommit": "5d036259EXAMPLE",
"destinationReference": "refs/heads/main",
"repositoryName": "MyDemoRepo",
"sourceCommit": "317f8570EXAMPLE",
"sourceReference": "refs/heads/jane-branch",
"mergeMetadata": {
"isMerged": false
}
}
],
"lastActivityDate": 1508962823.285,
"pullRequestId": "42",
"clientRequestToken": "123Example",
"pullRequestStatus": "OPEN",
"creationDate": 1508962823.285
}
}
```
+ For API details, see [CreatePullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request.html) in *AWS CLI Command Reference*.
### `create-repository`
The following code example shows how to use `create-repository`.
**AWS CLI**
**To create a repository**
This example creates a repository and associates it with the user's AWS account.
Command:
```
aws codecommit create-repository --repository-name MyDemoRepo --repository-description "My demonstration repository"
```
Output:
```
{
"repositoryMetadata": {
"repositoryName": "MyDemoRepo",
"cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
"lastModifiedDate": 1444766838.027,
"repositoryDescription": "My demonstration repository",
"cloneUrlHttp": "https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
"repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
"Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyDemoRepo",
"accountId": "111111111111"
}
}
```
+ For API details, see [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-repository.html) in *AWS CLI Command Reference*.
### `create-unreferenced-merge-commit`
The following code example shows how to use `create-unreferenced-merge-commit`.
**AWS CLI**
**To create an unreferenced commit that represents the result of merging two commit specifiers**
The following `create-unreferenced-merge-commit` example creates a commit that represents the results of a merge between a source branch named `bugfix-1234` with a destination branch named `main` using the THREE\$1WAY\$1MERGE strategy in a repository named `MyDemoRepo`.
```
aws codecommit create-unreferenced-merge-commit \
--source-commit-specifier bugfix-1234 \
--destination-commit-specifier main \
--merge-option THREE_WAY_MERGE \
--repository-name MyDemoRepo \
--name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "Testing the results of this merge."
```
Output:
```
{
"commitId": "4f178133EXAMPLE",
"treeId": "389765daEXAMPLE"
}
```
For more information, see [Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts) in the *AWS CodeCommit User Guide*.
+ For API details, see [CreateUnreferencedMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-unreferenced-merge-commit.html) in *AWS CLI Command Reference*.
### `credential-helper`
The following code example shows how to use `credential-helper`.
**AWS CLI**
**To set up the credential helper included in the AWS CLI with AWS CodeCommit**
The `credential-helper` utility is not designed to be called directly from the AWS CLI. Instead it is intended to be used as a parameter with the `git config` command to set up your local computer. It enables Git to use HTTPS and a cryptographically signed version of your IAM user credentials or Amazon EC2 instance role whenever Git needs to authenticate with AWS to interact with CodeCommit repositories.
```
git config --global credential.helper '!aws codecommit credential-helper $@'
git config --global credential.UseHttpPath true
```
Output:
```
[credential]
helper = !aws codecommit credential-helper $@
UseHttpPath = true
```
For more information, see Setting up for AWS CodeCommit Using Other Methods in the *AWS CodeCommit User Guide*. Review the content carefully, and then follow the procedures in one of the following topics: For HTTPS Connections on Linux, macOS, or Unix or For HTTPS Connections on Windows in the *AWS CodeCommit User Guide*.
+ For API details, see [CredentialHelper](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/credential-helper.html) in *AWS CLI Command Reference*.
### `delete-approval-rule-template`
The following code example shows how to use `delete-approval-rule-template`.
**AWS CLI**
**To delete an approval rule template**
The following `delete-approval-rule-template` example deletes the specified approval rule template.
```
aws codecommit delete-approval-rule-template \
--approval-rule-template-name 1-approver-for-all-pull-requests
```
Output:
```
{
"approvalRuleTemplateId": "41de97b7-EXAMPLE"
}
```
For more information, see [Delete an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-delete-template.html#delete-template) in the *AWS CodeCommit User Guide*.
+ For API details, see [DeleteApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-approval-rule-template.html) in *AWS CLI Command Reference*.
### `delete-branch`
The following code example shows how to use `delete-branch`.
**AWS CLI**
**To delete a branch**
This example shows how to delete a branch in an AWS CodeCommit repository.
Command:
```
aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch
```
Output:
```
{
"branch": {
"commitId": "317f8570EXAMPLE",
"branchName": "MyNewBranch"
}
}
```
+ For API details, see [DeleteBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-branch.html) in *AWS CLI Command Reference*.
### `delete-comment-content`
The following code example shows how to use `delete-comment-content`.
**AWS CLI**
**To delete the content of a comment**
You can only delete the content of a comment if you created the comment. This example demonstrates how to delete the content of a comment with the system-generated ID of `ff30b348EXAMPLEb9aa670f`.
```
aws codecommit delete-comment-content \
--comment-id ff30b348EXAMPLEb9aa670f
```
Output:
```
{
"comment": {
"creationDate": 1508369768.142,
"deleted": true,
"lastModifiedDate": 1508369842.278,
"clientRequestToken": "123Example",
"commentId": "ff30b348EXAMPLEb9aa670f",
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"callerReactions": [],
"reactionCounts":
{
"CLAP" : 1
}
}
}
```
+ For API details, see [DeleteCommentContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-comment-content.html) in *AWS CLI Command Reference*.
### `delete-file`
The following code example shows how to use `delete-file`.
**AWS CLI**
**To delete a file**
The following `delete-file` example demonstrates how to delete a file named `README.md` from a branch named `main` with a most recent commit ID of `c5709475EXAMPLE` in a repository named `MyDemoRepo`.
```
aws codecommit delete-file \
--repository-name MyDemoRepo \
--branch-name main \
--file-path README.md \
--parent-commit-id c5709475EXAMPLE
```
Output:
```
{
"blobId":"559b44fEXAMPLE",
"commitId":"353cf655EXAMPLE",
"filePath":"README.md",
"treeId":"6bc824cEXAMPLE"
}
```
For more information, see [Edit or Delete a File in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-file.html?shortFooter=true#how-to-edit-file-cli) in the *AWS CodeCommit API Reference* guide.
+ For API details, see [DeleteFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-file.html) in *AWS CLI Command Reference*.
### `delete-pull-request-approval-rule`
The following code example shows how to use `delete-pull-request-approval-rule`.
**AWS CLI**
**To delete an approval rule for a pull request**
The following `delete-pull-request-approval-rule` example deletes the approval rule named `My Approval Rule` for the specified pull request.
```
aws codecommit delete-pull-request-approval-rule \
--approval-rule-name "My Approval Rule" \
--pull-request-id 15
```
Output:
```
{
"approvalRuleId": "077d8e8a8-EXAMPLE"
}
```
For more information, see [Edit or Delete an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#delete-pull-request-approval-rule) in the *AWS CodeCommit User Guide*.
+ For API details, see [DeletePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-pull-request-approval-rule.html) in *AWS CLI Command Reference*.
### `delete-repository`
The following code example shows how to use `delete-repository`.
**AWS CLI**
**To delete a repository**
This example shows how to delete an AWS CodeCommit repository.
Command:
```
aws codecommit delete-repository --repository-name MyDemoRepo
```
Output:
```
{
"repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE"
}
```
+ For API details, see [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-repository.html) in *AWS CLI Command Reference*.
### `describe-merge-conflicts`
The following code example shows how to use `describe-merge-conflicts`.
**AWS CLI**
**To get detailed information about merge conflicts**
The following `describe-merge-conflicts` example determines the merge conflicts for a file named `readme.md` in the specified source branch and destination branch using the THREE\$1WAY\$1MERGE strategy.
```
aws codecommit describe-merge-conflicts \
--source-commit-specifier feature-randomizationfeature \
--destination-commit-specifier main \
--merge-option THREE_WAY_MERGE \
--file-path readme.md \
--repository-name MyDemoRepo
```
Output:
```
{
"conflictMetadata": {
"filePath": "readme.md",
"fileSizes": {
"source": 139,
"destination": 230,
"base": 85
},
"fileModes": {
"source": "NORMAL",
"destination": "NORMAL",
"base": "NORMAL"
},
"objectTypes": {
"source": "FILE",
"destination": "FILE",
"base": "FILE"
},
"numberOfConflicts": 1,
"isBinaryFile": {
"source": false,
"destination": false,
"base": false
},
"contentConflict": true,
"fileModeConflict": false,
"objectTypeConflict": false,
"mergeOperations": {
"source": "M",
"destination": "M"
}
},
"mergeHunks": [
{
"isConflict": true,
"source": {
"startLine": 0,
"endLine": 3,
"hunkContent": "VGhpcyBpEXAMPLE="
},
"destination": {
"startLine": 0,
"endLine": 1,
"hunkContent": "VXNlIHRoEXAMPLE="
}
}
],
"destinationCommitId": "86958e0aEXAMPLE",
"sourceCommitId": "6ccd57fdEXAMPLE",
"baseCommitId": "767b69580EXAMPLE"
}
```
For more information, see [Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#describe-merge-conflicts) in the *AWS CodeCommit User Guide*.
+ For API details, see [DescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-merge-conflicts.html) in *AWS CLI Command Reference*.
### `describe-pull-request-events`
The following code example shows how to use `describe-pull-request-events`.
**AWS CLI**
**To view events in a pull request**
The following `describe-pull-request-events` example retrieves the events for a pull request with the ID of '8'.
```
aws codecommit describe-pull-request-events --pull-request-id 8
```
Output:
```
{
"pullRequestEvents": [
{
"pullRequestId": "8",
"pullRequestEventType": "PULL_REQUEST_CREATED",
"eventDate": 1510341779.53,
"actor": "arn:aws:iam::111111111111:user/Zhang_Wei"
},
{
"pullRequestStatusChangedEventMetadata": {
"pullRequestStatus": "CLOSED"
},
"pullRequestId": "8",
"pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED",
"eventDate": 1510341930.72,
"actor": "arn:aws:iam::111111111111:user/Jane_Doe"
}
]
}
```
+ For API details, see [DescribePullRequestEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-pull-request-events.html) in *AWS CLI Command Reference*.
### `disassociate-approval-rule-template-from-repository`
The following code example shows how to use `disassociate-approval-rule-template-from-repository`.
**AWS CLI**
**To disassociate an approval rule template from a repository**
The following `disassociate-approval-rule-template-from-repository` example disassociates the specified approval rule template from a repository named `MyDemoRepo`.
```
aws codecommit disassociate-approval-rule-template-from-repository \
--repository-name MyDemoRepo \
--approval-rule-template-name 1-approver-rule-for-all-pull-requests
```
This command produces no output.
For more information, see [Disassociate an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#disassociate-template) in the *AWS CodeCommit User Guide*.
+ For API details, see [DisassociateApprovalRuleTemplateFromRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/disassociate-approval-rule-template-from-repository.html) in *AWS CLI Command Reference*.
### `evaluate-pull-request-approval-rules`
The following code example shows how to use `evaluate-pull-request-approval-rules`.
**AWS CLI**
**To evaluate whether a pull request has all of its approval rules satisfied**
The following `evaluate-pull-request-approval-rules` example evaluates the state of approval rules on the specified pull request. In this example, an approval rule has not been satisfied for the pull request, so the output of the command shows an `approved` value of `false`.
```
aws codecommit evaluate-pull-request-approval-rules \
--pull-request-id 27 \
--revision-id 9f29d167EXAMPLE
```
Output:
```
{
"evaluation": {
"approved": false,
"approvalRulesNotSatisfied": [
"Require two approved approvers"
],
"overridden": false,
"approvalRulesSatisfied": []
}
}
```
For more information, see [Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#evaluate-pull-request-approval-rules) in the *AWS CodeCommit User Guide*.
+ For API details, see [EvaluatePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/evaluate-pull-request-approval-rules.html) in *AWS CLI Command Reference*.
### `get-approval-rule-template`
The following code example shows how to use `get-approval-rule-template`.
**AWS CLI**
**To get the content of an approval rule template**
The following `get-approval-rule-template` example gets the content of an approval rule template named `1-approver-rule-for-all-pull-requests`.
```
aws codecommit get-approval-rule-template \
--approval-rule-template-name 1-approver-rule-for-all-pull-requests
```
Output:
```
{
"approvalRuleTemplate": {
"approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"ruleContentSha256": "621181bbEXAMPLE",
"lastModifiedDate": 1571356106.936,
"creationDate": 1571356106.936,
"approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan",
"approvalRuleTemplateId": "a29abb15-EXAMPLE",
"approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team."
}
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#get-template) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-approval-rule-template.html) in *AWS CLI Command Reference*.
### `get-blob`
The following code example shows how to use `get-blob`.
**AWS CLI**
**To view information about a Git blob object**
The following `get-blob` example retrieves information about a Git blob with the ID of '2eb4af3bEXAMPLE' in an AWS CodeCommit repository named 'MyDemoRepo'.
```
aws codecommit get-blob --repository-name MyDemoRepo --blob-id 2eb4af3bEXAMPLE
```
Output:
```
{
"content": "QSBCaW5hcnkgTGFyToEXAMPLE="
}
```
+ For API details, see [GetBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-blob.html) in *AWS CLI Command Reference*.
### `get-branch`
The following code example shows how to use `get-branch`.
**AWS CLI**
**To get information about a branch**
This example gets information about a branch in an AWS CodeCommit repository.
Command:
```
aws codecommit get-branch --repository-name MyDemoRepo --branch-name MyNewBranch
```
Output:
```
{
"BranchInfo": {
"commitID": "317f8570EXAMPLE",
"branchName": "MyNewBranch"
}
}
```
+ For API details, see [GetBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-branch.html) in *AWS CLI Command Reference*.
### `get-comment-reactions`
The following code example shows how to use `get-comment-reactions`.
**AWS CLI**
**To view emoji reactions to a comment**
The following `get-comment-reactions` example lists all emoji reactions to a comment with the ID of `abcd1234EXAMPLEb5678efgh`. If the font for your shell supports displaying Emoji Version 1.0, then in the output for `emoji` the emoji is displayed.
```
aws codecommit get-comment-reactions \
--comment-id abcd1234EXAMPLEb5678efgh
```
Output:
```
{
"reactionsForComment": {
[
{
"reaction": {
"emoji:"??",
"shortCode": "thumbsup",
"unicode": "U+1F44D"
},
"users": [
"arn:aws:iam::123456789012:user/Li_Juan",
"arn:aws:iam::123456789012:user/Mary_Major",
"arn:aws:iam::123456789012:user/Jorge_Souza"
]
},
{
"reaction": {
"emoji": "??",
"shortCode": "thumbsdown",
"unicode": "U+1F44E"
},
"users": [
"arn:aws:iam::123456789012:user/Nikhil_Jayashankar"
]
},
{
"reaction": {
"emoji": "??",
"shortCode": "confused",
"unicode": "U+1F615"
},
"users": [
"arn:aws:iam::123456789012:user/Saanvi_Sarkar"
]
}
]
}
}
```
For more information, see [Comment on a commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-emoji-view) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetCommentReactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment-reactions.html) in *AWS CLI Command Reference*.
### `get-comment`
The following code example shows how to use `get-comment`.
**AWS CLI**
**To view details of a comment**
This example demonstrates how to view details of a comment with the system-generated comment ID of `ff30b348EXAMPLEb9aa670f`.
```
aws codecommit get-comment \
--comment-id ff30b348EXAMPLEb9aa670f
```
Output:
```
{
"comment": {
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "123Example",
"commentId": "ff30b348EXAMPLEb9aa670f",
"content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.",
"creationDate": 1508369768.142,
"deleted": false,
"commentId": "",
"lastModifiedDate": 1508369842.278,
"callerReactions": [],
"reactionCounts":
{
"SMILE" : 6,
"THUMBSUP" : 1
}
}
}
```
+ For API details, see [GetComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment.html) in *AWS CLI Command Reference*.
### `get-comments-for-compared-commit`
The following code example shows how to use `get-comments-for-compared-commit`.
**AWS CLI**
**To view comments on a commit**
This example demonstrates how to view view comments made on the comparison between two commits in a repository named `MyDemoRepo`.
```
aws codecommit get-comments-for-compared-commit \
--repository-name MyDemoRepo \
--before-commit-ID 6e147360EXAMPLE \
--after-commit-id 317f8570EXAMPLE
```
Output:
```
{
"commentsForComparedCommitData": [
{
"afterBlobId": "1f330709EXAMPLE",
"afterCommitId": "317f8570EXAMPLE",
"beforeBlobId": "80906a4cEXAMPLE",
"beforeCommitId": "6e147360EXAMPLE",
"comments": [
{
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "123Example",
"commentId": "ff30b348EXAMPLEb9aa670f",
"content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.",
"creationDate": 1508369768.142,
"deleted": false,
"CommentId": "123abc-EXAMPLE",
"lastModifiedDate": 1508369842.278,
"callerReactions": [],
"reactionCounts":
{
"SMILE" : 6,
"THUMBSUP" : 1
}
},
{
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "123Example",
"commentId": "553b509bEXAMPLE56198325",
"content": "Can you add a test case for this?",
"creationDate": 1508369612.240,
"deleted": false,
"commentId": "456def-EXAMPLE",
"lastModifiedDate": 1508369612.240,
"callerReactions": [],
"reactionCounts":
{
"THUMBSUP" : 2
}
}
],
"location": {
"filePath": "cl_sample.js",
"filePosition": 1232,
"relativeFileVersion": "after"
},
"repositoryName": "MyDemoRepo"
}
],
"nextToken": "exampleToken"
}
```
+ For API details, see [GetCommentsForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-compared-commit.html) in *AWS CLI Command Reference*.
### `get-comments-for-pull-request`
The following code example shows how to use `get-comments-for-pull-request`.
**AWS CLI**
**To view comments for a pull request**
This example demonstrates how to view comments for a pull request in a repository named `MyDemoRepo`.
```
aws codecommit get-comments-for-pull-request \
--repository-name MyDemoRepo \
--before-commit-ID 317f8570EXAMPLE \
--after-commit-id 5d036259EXAMPLE
```
Output:
```
{
"commentsForPullRequestData": [
{
"afterBlobId": "1f330709EXAMPLE",
"afterCommitId": "5d036259EXAMPLE",
"beforeBlobId": "80906a4cEXAMPLE",
"beforeCommitId": "317f8570EXAMPLE",
"comments": [
{
"authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar",
"clientRequestToken": "",
"commentId": "abcd1234EXAMPLEb5678efgh",
"content": "These don't appear to be used anywhere. Can we remove them?",
"creationDate": 1508369622.123,
"deleted": false,
"lastModifiedDate": 1508369622.123,
"callerReactions": [],
"reactionCounts":
{
"THUMBSUP" : 6,
"CONFUSED" : 1
}
},
{
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "",
"commentId": "442b498bEXAMPLE5756813",
"content": "Good catch. I'll remove them.",
"creationDate": 1508369829.104,
"deleted": false,
"lastModifiedDate": 150836912.273,
"callerReactions": ["THUMBSUP"]
"reactionCounts":
{
"THUMBSUP" : 14
}
}
],
"location": {
"filePath": "ahs_count.py",
"filePosition": 367,
"relativeFileVersion": "AFTER"
},
"repositoryName": "MyDemoRepo",
"pullRequestId": "42"
}
],
"nextToken": "exampleToken"
}
```
+ For API details, see [GetCommentsForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-pull-request.html) in *AWS CLI Command Reference*.
### `get-commit`
The following code example shows how to use `get-commit`.
**AWS CLI**
**To view information about a commit in a repository**
This example shows details about a commit with the system-generated ID of '7e9fd3091thisisanexamplethisisanexample1' in an AWS CodeCommit repository named 'MyDemoRepo'.
Command:
```
aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1
```
Output:
```
{
"commit": {
"additionalData": "",
"committer": {
"date": "1484167798 -0800",
"name": "Mary Major",
"email": "mary_major@example.com"
},
"author": {
"date": "1484167798 -0800",
"name": "Mary Major",
"email": "mary_major@example.com"
},
"treeId": "347a3408thisisanexampletreeidexample",
"parents": [
"7aa87a031thisisanexamplethisisanexample1"
],
"message": "Fix incorrect variable name"
}
}
```
+ For API details, see [GetCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-commit.html) in *AWS CLI Command Reference*.
### `get-differences`
The following code example shows how to use `get-differences`.
**AWS CLI**
**To get information about differences for a commit specifier in a repository**
This example shows view metadata information about changes between two commit specifiers (branch, tag, HEAD, or other fully qualified references, such as commit IDs) in a renamed folder in AWS CodeCommit repository named MyDemoRepo. The example includes several options that are not required, including --before-commit-specifier, --before-path, and --after-path, in order to more fully illustrate how you can use these options to limit the results. The response includes file mode permissions.
Command:
```
aws codecommit get-differences --repository-name MyDemoRepo --before-commit-specifier 955bba12thisisanexamplethisisanexample --after-commit-specifier 14a95463thisisanexamplethisisanexample --before-path tmp/example-folder --after-path tmp/renamed-folder
```
Output:
```
{
"differences": [
{
"afterBlob": {
"path": "blob.txt",
"blobId": "2eb4af3b1thisisanexamplethisisanexample1",
"mode": "100644"
},
"changeType": "M",
"beforeBlob": {
"path": "blob.txt",
"blobId": "bf7fcf281thisisanexamplethisisanexample1",
"mode": "100644"
}
}
]
}
```
+ For API details, see [GetDifferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-differences.html) in *AWS CLI Command Reference*.
### `get-file`
The following code example shows how to use `get-file`.
**AWS CLI**
**To get the base-64 encoded contents of a file in an AWS CodeCommit repository**
The following `get-file` example demonstrates how to get the base-64 encoded contents of a file named `README.md` from a branch named `main` in a repository named `MyDemoRepo`.
```
aws codecommit get-file \
--repository-name MyDemoRepo \
--commit-specifier main \
--file-path README.md
```
Output:
```
{
"blobId":"559b44fEXAMPLE",
"commitId":"c5709475EXAMPLE",
"fileContent":"IyBQaHVzEXAMPLE",
"filePath":"README.md",
"fileMode":"NORMAL",
"fileSize":1563
}
```
For more information, see [GetFile](https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFile.html) in the *AWS CodeCommit API Reference* guide.
+ For API details, see [GetFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-file.html) in *AWS CLI Command Reference*.
### `get-folder`
The following code example shows how to use `get-folder`.
**AWS CLI**
**To get the contents of a folder in an AWS CodeCommit repository**
The following `get-folder` example demonstrates how to get the contents of a top-level folder from a repository named `MyDemoRepo`.
```
aws codecommit get-folder --repository-name MyDemoRepo --folder-path ""
```
Output:
```
{
"commitId":"c5709475EXAMPLE",
"files":[
{
"absolutePath":".gitignore",
"blobId":"74094e8bEXAMPLE",
"fileMode":"NORMAL",
"relativePath":".gitignore"
},
{
"absolutePath":"Gemfile",
"blobId":"9ceb72f6EXAMPLE",
"fileMode":"NORMAL",
"relativePath":"Gemfile"
},
{
"absolutePath":"Gemfile.lock",
"blobId":"795c4a2aEXAMPLE",
"fileMode":"NORMAL",
"relativePath":"Gemfile.lock"
},
{
"absolutePath":"LICENSE.txt",
"blobId":"0c7932c8EXAMPLE",
"fileMode":"NORMAL",
"relativePath":"LICENSE.txt"
},
{
"absolutePath":"README.md",
"blobId":"559b44feEXAMPLE",
"fileMode":"NORMAL",
"relativePath":"README.md"
}
],
"folderPath":"",
"subFolders":[
{
"absolutePath":"public",
"relativePath":"public",
"treeId":"d5e92ae3aEXAMPLE"
},
{
"absolutePath":"tmp",
"relativePath":"tmp",
"treeId":"d564d0bcEXAMPLE"
}
],
"subModules":[],
"symbolicLinks":[],
"treeId":"7b3c4dadEXAMPLE"
}
```
For more information, see GetFolder in the *AWS CodeCommit API Reference* guide.
+ For API details, see [GetFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-folder.html) in *AWS CLI Command Reference*.
### `get-merge-commit`
The following code example shows how to use `get-merge-commit`.
**AWS CLI**
**To get detailed information about a merge commit**
The following `get-merge-commit` example displays details about a merge commit for the source branch named `bugfix-bug1234` with a destination branch named `main` in a repository named `MyDemoRepo`.
```
aws codecommit get-merge-commit \
--source-commit-specifier bugfix-bug1234 \
--destination-commit-specifier main \
--repository-name MyDemoRepo
```
Output:
```
{
"sourceCommitId": "c5709475EXAMPLE",
"destinationCommitId": "317f8570EXAMPLE",
"baseCommitId": "fb12a539EXAMPLE",
"mergeCommitId": "ffc4d608eEXAMPLE"
}
```
For more information, see [View Commit Details](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-merge-commit) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-commit.html) in *AWS CLI Command Reference*.
### `get-merge-conflicts`
The following code example shows how to use `get-merge-conflicts`.
**AWS CLI**
**To view whether there are any merge conflicts for a pull request**
The following `get-merge-conflicts` example displays whether there are any merge conflicts between the tip of a source branch named `feature-randomizationfeature` and a destination branch named 'main' in a repository named `MyDemoRepo`.
```
aws codecommit get-merge-conflicts \
--repository-name MyDemoRepo \
--source-commit-specifier feature-randomizationfeature \
--destination-commit-specifier main \
--merge-option THREE_WAY_MERGE
```
Output:
```
{
"mergeable": false,
"destinationCommitId": "86958e0aEXAMPLE",
"sourceCommitId": "6ccd57fdEXAMPLE",
"baseCommitId": "767b6958EXAMPLE",
"conflictMetadataList": [
{
"filePath": "readme.md",
"fileSizes": {
"source": 139,
"destination": 230,
"base": 85
},
"fileModes": {
"source": "NORMAL",
"destination": "NORMAL",
"base": "NORMAL"
},
"objectTypes": {
"source": "FILE",
"destination": "FILE",
"base": "FILE"
},
"numberOfConflicts": 1,
"isBinaryFile": {
"source": false,
"destination": false,
"base": false
},
"contentConflict": true,
"fileModeConflict": false,
"objectTypeConflict": false,
"mergeOperations": {
"source": "M",
"destination": "M"
}
}
]
}
```
+ For API details, see [GetMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-conflicts.html) in *AWS CLI Command Reference*.
### `get-merge-options`
The following code example shows how to use `get-merge-options`.
**AWS CLI**
**To get information about the merge options available for merging two specified branches**
The following `get-merge-options` example determines the merge options available for merging a source branch named `bugfix-bug1234` with a destination branch named `main` in a repository named `MyDemoRepo`.
```
aws codecommit get-merge-options \
--source-commit-specifier bugfix-bug1234 \
--destination-commit-specifier main \
--repository-name MyDemoRepo
```
Output:
```
{
"mergeOptions": [
"FAST_FORWARD_MERGE",
"SQUASH_MERGE",
"THREE_WAY_MERGE"
],
"sourceCommitId": "18059494EXAMPLE",
"destinationCommitId": "ffd3311dEXAMPLE",
"baseCommitId": "ffd3311dEXAMPLE"
}
```
For more information, see [Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#get-merge-options) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetMergeOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-options.html) in *AWS CLI Command Reference*.
### `get-pull-request-approval-states`
The following code example shows how to use `get-pull-request-approval-states`.
**AWS CLI**
**To view approvals on a pull request**
The following `get-pull-request-approval-states` example returns approvals for the specified pull request.
```
aws codecommit get-pull-request-approval-states \
--pull-request-id 8 \
--revision-id 9f29d167EXAMPLE
```
Output:
```
{
"approvals": [
{
"userArn": "arn:aws:iam::123456789012:user/Mary_Major",
"approvalState": "APPROVE"
}
]
}
```
For more information, see [View Pull Requests](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-pull-request.html#get-pull-request-approval-state) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetPullRequestApprovalStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-approval-states.html) in *AWS CLI Command Reference*.
### `get-pull-request-override-state`
The following code example shows how to use `get-pull-request-override-state`.
**AWS CLI**
**To get information about the override status of a pull request**
The following `get-pull-request-override-state` example returns the override state for the specified pull request. In this example, the approval rules for the pull request were overridden by a user named Mary Major, so the output returns a value of `true`.:
```
aws codecommit get-pull-request-override-state \
--pull-request-id 34 \
--revision-id 9f29d167EXAMPLE
```
Output:
```
{
"overridden": true,
"overrider": "arn:aws:iam::123456789012:user/Mary_Major"
}
```
For more information, see [Override Approval Rules on a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#get-override-status) in the *AWS CodeCommit User Guide*.
+ For API details, see [GetPullRequestOverrideState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-override-state.html) in *AWS CLI Command Reference*.
### `get-pull-request`
The following code example shows how to use `get-pull-request`.
**AWS CLI**
**To view details of a pull request**
This example demonstrates how to view information about a pull request with the ID of `27`.
```
aws codecommit get-pull-request \
--pull-request-id 27
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"lastActivityDate": 1562619583.565,
"pullRequestTargets": [
{
"sourceCommit": "ca45e279EXAMPLE",
"sourceReference": "refs/heads/bugfix-1234",
"mergeBase": "a99f5ddbEXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": false
},
"destinationCommit": "2abfc6beEXAMPLE",
"repositoryName": "MyDemoRepo"
}
],
"revisionId": "e47def21EXAMPLE",
"title": "Quick fix for bug 1234",
"authorArn": "arn:aws:iam::123456789012:user/Nikhil_Jayashankar",
"clientRequestToken": "d8d7612e-EXAMPLE",
"creationDate": 1562619583.565,
"pullRequestId": "27",
"pullRequestStatus": "OPEN"
}
}
```
+ For API details, see [GetPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request.html) in *AWS CLI Command Reference*.
### `get-repository-triggers`
The following code example shows how to use `get-repository-triggers`.
**AWS CLI**
**To get information about triggers in a repository**
This example shows details about triggers configured for an AWS CodeCommit repository named `MyDemoRepo`.
```
aws codecommit get-repository-triggers \
--repository-name MyDemoRepo
```
Output:
```
{
"configurationId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
"triggers": [
{
"destinationArn": "arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic",
"branches": [
"main",
"preprod"
],
"name": "MyFirstTrigger",
"customData": "",
"events": [
"all"
]
},
{
"destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction",
"branches": [],
"name": "MySecondTrigger",
"customData": "EXAMPLE",
"events": [
"all"
]
}
]
}
```
+ For API details, see [GetRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository-triggers.html) in *AWS CLI Command Reference*.
### `get-repository`
The following code example shows how to use `get-repository`.
**AWS CLI**
**To get information about a repository**
This example shows details about an AWS CodeCommit repository.
```
aws codecommit get-repository \
--repository-name MyDemoRepo
```
Output:
```
{
"repositoryMetadata": {
"creationDate": 1429203623.625,
"defaultBranch": "main",
"repositoryName": "MyDemoRepo",
"cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo",
"lastModifiedDate": 1430783812.0869999,
"repositoryDescription": "My demonstration repository",
"cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo",
"repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
"Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
"accountId": "111111111111"
}
}
```
+ For API details, see [GetRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository.html) in *AWS CLI Command Reference*.
### `list-approval-rule-templates`
The following code example shows how to use `list-approval-rule-templates`.
**AWS CLI**
**To list all approval rule templates in an AWS Region**
The following `list-approval-rule-templates` example lists all approval rule templates in the specified Region. If no AWS Region is specified as a parameter, the command returns approval rule templates for the region specified in the AWS CLI profile used to run the command.
```
aws codecommit list-approval-rule-templates \
--region us-east-2
```
Output:
```
{
"approvalRuleTemplateNames": [
"2-approver-rule-for-main",
"1-approver-rule-for-all-pull-requests"
]
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-templates) in the *AWS CodeCommit User Guide*.
+ For API details, see [ListApprovalRuleTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-approval-rule-templates.html) in *AWS CLI Command Reference*.
### `list-associated-approval-rule-templates-for-repository`
The following code example shows how to use `list-associated-approval-rule-templates-for-repository`.
**AWS CLI**
**To list all templates associated with a repository**
The following `list-associated-approval-rule-templates-for-repository` example lists all approval rule templates associated with a repository named `MyDemoRepo`.
```
aws codecommit list-associated-approval-rule-templates-for-repository \
--repository-name MyDemoRepo
```
Output:
```
{
"approvalRuleTemplateNames": [
"2-approver-rule-for-main",
"1-approver-rule-for-all-pull-requests"
]
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-templates) in the *AWS CodeCommit User Guide*.
+ For API details, see [ListAssociatedApprovalRuleTemplatesForRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-associated-approval-rule-templates-for-repository.html) in *AWS CLI Command Reference*.
### `list-branches`
The following code example shows how to use `list-branches`.
**AWS CLI**
**To view a list of branch names**
This example lists all branch names in an AWS CodeCommit repository.
```
aws codecommit list-branches \
--repository-name MyDemoRepo
```
Output:
```
{
"branches": [
"MyNewBranch",
"main"
]
}
```
+ For API details, see [ListBranches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-branches.html) in *AWS CLI Command Reference*.
### `list-pull-requests`
The following code example shows how to use `list-pull-requests`.
**AWS CLI**
**To view a list of pull requests in a repository**
This example demonstrates how to list pull requests created by an IAM user with the ARN 'arn:aws:iam::111111111111:user/Li\$1Juan' and the status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':
```
aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo
```
Output:
```
{
"nextToken": "",
"pullRequestIds": ["2","12","16","22","23","35","30","39","47"]
}
```
+ For API details, see [ListPullRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-pull-requests.html) in *AWS CLI Command Reference*.
### `list-repositories-for-approval-rule-template`
The following code example shows how to use `list-repositories-for-approval-rule-template`.
**AWS CLI**
**To list all repositories associated with a template**
The following `list-repositories-for-approval-rule-template` example lists all repositories associated with the specified approval rule template.
```
aws codecommit list-repositories-for-approval-rule-template \
--approval-rule-template-name 2-approver-rule-for-main
```
Output:
```
{
"repositoryNames": [
"MyDemoRepo",
"MyClonedRepo"
]
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-repositories) in the *AWS CodeCommit User Guide*.
+ For API details, see [ListRepositoriesForApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories-for-approval-rule-template.html) in *AWS CLI Command Reference*.
### `list-repositories`
The following code example shows how to use `list-repositories`.
**AWS CLI**
**To view a list of repositories**
This example lists all AWS CodeCommit repositories associated with the user's AWS account.
Command:
```
aws codecommit list-repositories
```
Output:
```
{
"repositories": [
{
"repositoryName": "MyDemoRepo"
"repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE",
},
{
"repositoryName": "MyOtherDemoRepo"
"repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE"
}
]
}
```
+ For API details, see [ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To view the AWS tags for a repository**
The following `list-tags-for-resource` example lists tag keys and tag values for the specified repository.
```
aws codecommit list-tags-for-resource \
--resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo
```
Output:
```
{
"tags": {
"Status": "Secret",
"Team": "Saanvi"
}
}
```
For more information, see [View Tags for a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-list.html#how-to-tag-repository-list-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `merge-branches-by-fast-forward`
The following code example shows how to use `merge-branches-by-fast-forward`.
**AWS CLI**
**To merge two branches using the fast-forward merge strategy**
The following `merge-branches-by-fast-forward` example merges the specified source branch with the specified destination branch in a repository named `MyDemoRepo`.
```
aws codecommit merge-branches-by-fast-forward \
--source-commit-specifier bugfix-bug1234 \
--destination-commit-specifier bugfix-bug1233 \
--repository-name MyDemoRepo
```
Output:
```
{
"commitId": "4f178133EXAMPLE",
"treeId": "389765daEXAMPLE"
}
```
For more information, see [Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-fast-forward) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergeBranchesByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-fast-forward.html) in *AWS CLI Command Reference*.
### `merge-branches-by-squash`
The following code example shows how to use `merge-branches-by-squash`.
**AWS CLI**
**To merge two branches using the squash merge strategy**
The following `merge-branches-by-squash` example merges the specified source branch with the specified destination branch in a repository named `MyDemoRepo`.
```
aws codecommit merge-branches-by-squash \
--source-commit-specifier bugfix-bug1234 \
--destination-commit-specifier bugfix-bug1233 \
--author-name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "Merging two fix branches to prepare for a general patch." \
--repository-name MyDemoRepo
```
Output:
```
{
"commitId": "4f178133EXAMPLE",
"treeId": "389765daEXAMPLE"
}
```
For more information, see [Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-squash) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergeBranchesBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-squash.html) in *AWS CLI Command Reference*.
### `merge-branches-by-three-way`
The following code example shows how to use `merge-branches-by-three-way`.
**AWS CLI**
**To merge two branches using the three-way merge strategy**
The following `merge-branches-by-three-way` example merges the specified source branch with the specified destination branch in a repository named `MyDemoRepo`.
```
aws codecommit merge-branches-by-three-way \
--source-commit-specifier main \
--destination-commit-specifier bugfix-bug1234 \
--author-name "Jorge Souza" --email "jorge_souza@example.com" \
--commit-message "Merging changes from main to bugfix branch before additional testing." \
--repository-name MyDemoRepo
```
Output:
```
{
"commitId": "4f178133EXAMPLE",
"treeId": "389765daEXAMPLE"
}
```
For more information, see [Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-three-way) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergeBranchesByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-three-way.html) in *AWS CLI Command Reference*.
### `merge-pull-request-by-fast-forward`
The following code example shows how to use `merge-pull-request-by-fast-forward`.
**AWS CLI**
**To merge and close a pull request**
This example demonstrates how to merge and close a pull request with the ID of '47' and a source commit ID of '99132ab0EXAMPLE' in a repository named `MyDemoRepo`.
```
aws codecommit merge-pull-request-by-fast-forward \
--pull-request-id 47 \
--source-commit-id 99132ab0EXAMPLE \
--repository-name MyDemoRepo
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "I want one approver for this pull request",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.142,
"description": "Review the latest changes and updates to the global variables",
"lastActivityDate": 1508887223.155,
"pullRequestId": "47",
"pullRequestStatus": "CLOSED",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": true,
"mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables"
}
}
```
For more information, see [Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-fast-forward) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergePullRequestByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-fast-forward.html) in *AWS CLI Command Reference*.
### `merge-pull-request-by-squash`
The following code example shows how to use `merge-pull-request-by-squash`.
**AWS CLI**
**To merge a pull request using the squash merge strategy**
The following `merge-pull-request-by-squash` example merges and closes the specified pull request using the conflict resolution strategy of ACCEPT\$1SOURCE in a repository named `MyDemoRepo`.
```
aws codecommit merge-pull-request-by-squash \
--pull-request-id 47 \
--source-commit-id 99132ab0EXAMPLE \
--repository-name MyDemoRepo \
--conflict-detail-level LINE_LEVEL \
--conflict-resolution-strategy ACCEPT_SOURCE \
--name "Jorge Souza" --email "jorge_souza@example.com" \
--commit-message "Merging pull request 47 by squash and accepting source in merge conflicts"
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"originApprovalRuleTemplate": {
"approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
"approvalRuleTemplateName": "2-approver-rule-for-main"
},
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.142,
"description": "Review the latest changes and updates to the global variables",
"lastActivityDate": 1508887223.155,
"pullRequestId": "47",
"pullRequestStatus": "CLOSED",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": true,
"mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables"
}
}
```
For more information, see [Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-squash) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergePullRequestBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-squash.html) in *AWS CLI Command Reference*.
### `merge-pull-request-by-three-way`
The following code example shows how to use `merge-pull-request-by-three-way`.
**AWS CLI**
**To merge a pull request using the three-way merge strategy**
The following `merge-pull-request-by-three-way` example merges and closes the specified pull request using the default options for conflict detail and conflict resolution strategy in a repository named `MyDemoRepo`.
```
aws codecommit merge-pull-request-by-three-way \
--pull-request-id 47 \
--source-commit-id 99132ab0EXAMPLE \
--repository-name MyDemoRepo \
--name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "Merging pull request 47 by three-way with default options"
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"originApprovalRuleTemplate": {
"approvalRuleTemplateId": "dd8b17fe-EXAMPLE",
"approvalRuleTemplateName": "2-approver-rule-for-main"
},
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.142,
"description": "Review the latest changes and updates to the global variables",
"lastActivityDate": 1508887223.155,
"pullRequestId": "47",
"pullRequestStatus": "CLOSED",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": true,
"mergedBy": "arn:aws:iam::123456789012:user/Mary_Major"
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables"
}
}
```
For more information, see [Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-three-way) in the *AWS CodeCommit User Guide*.
+ For API details, see [MergePullRequestByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-three-way.html) in *AWS CLI Command Reference*.
### `override-pull-request-approval-rules`
The following code example shows how to use `override-pull-request-approval-rules`.
**AWS CLI**
**To override approval rule requirements on a pull request**
The following `override-pull-request-approval-rules` example overrides approval rules on the specified pull request. To revoke an override instead, set the `--override-status` parameter value to `REVOKE`.
```
aws codecommit override-pull-request-approval-rules \
--pull-request-id 34 \
--revision-id 927df8d8EXAMPLE \
--override-status OVERRIDE
```
This command produces no output.
For more information, see [Override Approval Rules on a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#override-approval-rules) in the *AWS CodeCommit User Guide*.
+ For API details, see [OverridePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/override-pull-request-approval-rules.html) in *AWS CLI Command Reference*.
### `post-comment-for-compared-commit`
The following code example shows how to use `post-comment-for-compared-commit`.
**AWS CLI**
**To create a comment on a commit**
This example demonstrates how to add the comment `"Can you add a test case for this?"` on the change to the `cl_sample.js` file in the comparison between two commits in a repository named `MyDemoRepo`.
```
aws codecommit post-comment-for-compared-commit \
--repository-name MyDemoRepo \
--before-commit-id 317f8570EXAMPLE \
--after-commit-id 5d036259EXAMPLE \
--client-request-token 123Example \
--content "Can you add a test case for this?" \
--location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER
```
Output:
```
{
"afterBlobId": "1f330709EXAMPLE",
"afterCommitId": "317f8570EXAMPLE",
"beforeBlobId": "80906a4cEXAMPLE",
"beforeCommitId": "6e147360EXAMPLE",
"comment": {
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "",
"commentId": "553b509bEXAMPLE56198325",
"content": "Can you add a test case for this?",
"creationDate": 1508369612.203,
"deleted": false,
"commentId": "abc123-EXAMPLE",
"lastModifiedDate": 1508369612.203,
"callerReactions": [],
"reactionCounts": []
},
"location": {
"filePath": "cl_sample.js",
"filePosition": 1232,
"relativeFileVersion": "AFTER"
,
"repositoryName": "MyDemoRepo"
}
}
```
+ For API details, see [PostCommentForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-compared-commit.html) in *AWS CLI Command Reference*.
### `post-comment-for-pull-request`
The following code example shows how to use `post-comment-for-pull-request`.
**AWS CLI**
**To add a comment to a pull request**
The following `post-comment-for-pull-request` example adds the comment "These don't appear to be used anywhere. Can we remove them?" on the change to the `ahs_count.py` file in a pull request with the ID of `47` in a repository named `MyDemoRepo`.
```
aws codecommit post-comment-for-pull-request \
--pull-request-id "47" \
--repository-name MyDemoRepo \
--before-commit-id 317f8570EXAMPLE \
--after-commit-id 5d036259EXAMPLE \
--client-request-token 123Example \
--content "These don't appear to be used anywhere. Can we remove them?" \
--location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER
```
Output:
```
{
"afterBlobId": "1f330709EXAMPLE",
"afterCommitId": "5d036259EXAMPLE",
"beforeBlobId": "80906a4cEXAMPLE",
"beforeCommitId": "317f8570EXAMPLE",
"comment": {
"authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar",
"clientRequestToken": "123Example",
"commentId": "abcd1234EXAMPLEb5678efgh",
"content": "These don't appear to be used anywhere. Can we remove them?",
"creationDate": 1508369622.123,
"deleted": false,
"CommentId": "",
"lastModifiedDate": 1508369622.123,
"callerReactions": [],
"reactionCounts": []
},
"location": {
"filePath": "ahs_count.py",
"filePosition": 367,
"relativeFileVersion": "AFTER"
},
"repositoryName": "MyDemoRepo",
"pullRequestId": "47"
}
```
+ For API details, see [PostCommentForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-pull-request.html) in *AWS CLI Command Reference*.
### `post-comment-reply`
The following code example shows how to use `post-comment-reply`.
**AWS CLI**
**To reply to a comment on a commit or in a pull request**
This example demonstrates how to add the reply `"Good catch. I'll remove them."` to the comment with the system-generated ID of `abcd1234EXAMPLEb5678efgh`.
```
aws codecommit post-comment-reply \
--in-reply-to abcd1234EXAMPLEb5678efgh \
--content "Good catch. I'll remove them." \
--client-request-token 123Example
```
Output:
```
{
"comment": {
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "123Example",
"commentId": "442b498bEXAMPLE5756813",
"content": "Good catch. I'll remove them.",
"creationDate": 1508369829.136,
"deleted": false,
"CommentId": "abcd1234EXAMPLEb5678efgh",
"lastModifiedDate": 150836912.221,
"callerReactions": [],
"reactionCounts": []
}
}
```
+ For API details, see [PostCommentReply](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-reply.html) in *AWS CLI Command Reference*.
### `put-comment-reaction`
The following code example shows how to use `put-comment-reaction`.
**AWS CLI**
**To reply to a comment on a commit with an emoji**
The following `put-comment-reaction` example replies to a comment with the ID of `abcd1234EXAMPLEb5678efgh` with an emoji reaction value of `:thumbsup:`.
```
aws codecommit put-comment-reaction \
--comment-id abcd1234EXAMPLEb5678efgh \
--reaction-value :thumbsup:
```
This command produces no output.
For more information, see [Comment on a commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-reply-emoji) in the *AWS CodeCommit User Guide*.
+ For API details, see [PutCommentReaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-comment-reaction.html) in *AWS CLI Command Reference*.
### `put-file`
The following code example shows how to use `put-file`.
**AWS CLI**
**To add a file to a repository**
The following `put-file` example adds a file named 'ExampleSolution.py' to a repository named 'MyDemoRepo' to a branch named 'feature-randomizationfeature' whose most recent commit has an ID of '4c925148EXAMPLE'.
```
aws codecommit put-file \
--repository-name MyDemoRepo \
--branch-name feature-randomizationfeature \
--file-content file://MyDirectory/ExampleSolution.py \
--file-path /solutions/ExampleSolution.py \
--parent-commit-id 4c925148EXAMPLE \
--name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "I added a third randomization routine."
```
Output:
```
{
"blobId": "2eb4af3bEXAMPLE",
"commitId": "317f8570EXAMPLE",
"treeId": "347a3408EXAMPLE"
}
```
+ For API details, see [PutFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-file.html) in *AWS CLI Command Reference*.
### `put-repository-triggers`
The following code example shows how to use `put-repository-triggers`.
**AWS CLI**
**To add or update a trigger in a repository**
This example demonstrates how to update triggers named 'MyFirstTrigger' and 'MySecondTrigger' using an already-created JSON file (here named MyTriggers.json) that contains the structure of all the triggers for a repository named MyDemoRepo. To learn how to get the JSON for existing triggers, see the get-repository-triggers command.
```
aws codecommit put-repository-triggers \
--repository-name MyDemoRepo file://MyTriggers.json
```
Contents of `MyTriggers.json`:
```
{
"repositoryName": "MyDemoRepo",
"triggers": [
{
"destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic",
"branches": [
"main",
"preprod"
],
"name": "MyFirstTrigger",
"customData": "",
"events": [
"all"
]
},
{
"destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction",
"branches": [],
"name": "MySecondTrigger",
"customData": "EXAMPLE",
"events": [
"all"
]
}
]
}
```
Output:
```
{
"configurationId": "6fa51cd8-35c1-EXAMPLE"
}
```
+ For API details, see [PutRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-repository-triggers.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To add AWS tags to an existing repository**
The following `tag-resource` example tags the specified repository with two tags.
```
aws codecommit tag-resource \
--resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \
--tags Status=Secret,Team=Saanvi
```
This command produces no output.
For more information, see [Add a Tag to a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-add.html#how-to-tag-repository-add-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/tag-resource.html) in *AWS CLI Command Reference*.
### `test-repository-triggers`
The following code example shows how to use `test-repository-triggers`.
**AWS CLI**
**To test triggers in a repository**
This example demonstrates how to test a trigger named 'MyFirstTrigger' in an AWS CodeCommit repository named MyDemoRepo. In this example, events in the repository trigger notifications from an Amazon Simple Notification Service (Amazon SNS) topic.
Command:
```
aws codecommit test-repository-triggers --repository-name MyDemoRepo --triggers name=MyFirstTrigger,destinationArn=arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic,branches=mainline,preprod,events=all
```
Output:
```
{
"successfulExecutions": [
"MyFirstTrigger"
],
"failedExecutions": []
}
```
+ For API details, see [TestRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/test-repository-triggers.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove AWS tags from a repository**
The following `untag-resource` example removes the tag with the specified key from the repository named `MyDemoRepo`.
```
aws codecommit untag-resource \
--resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \
--tag-keys Status
```
This command produces no output.
For more information, see [Remove a Tag from a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-delete.html#how-to-tag-repository-delete-cli) in the *AWS CodeCommit User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/untag-resource.html) in *AWS CLI Command Reference*.
### `update-approval-rule-template-content`
The following code example shows how to use `update-approval-rule-template-content`.
**AWS CLI**
**To update the content of an approval rule template**
The following `update-approval-rule-template-content` example changes the content of the specified approval rule template to redefine the approval pool to users who assume the role of `CodeCommitReview`.
```
aws codecommit update-approval-rule-template-content \
--approval-rule-template-name 1-approver-rule \
--new-rule-content "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}"
```
Output:
```
{
"approvalRuleTemplate": {
"creationDate": 1571352720.773,
"approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool",
"lastModifiedDate": 1571358728.41,
"approvalRuleTemplateId": "41de97b7-EXAMPLE",
"approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
"ruleContentSha256": "2f6c21a5EXAMPLE",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan"
}
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-content) in the *AWS CodeCommit User Guide*.
+ For API details, see [UpdateApprovalRuleTemplateContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-content.html) in *AWS CLI Command Reference*.
### `update-approval-rule-template-description`
The following code example shows how to use `update-approval-rule-template-description`.
**AWS CLI**
**To update the description of an approval rule template**
The following `update-approval-rule-template-description` example changes the description of the specified approval rule template to `Requires 1 approval for all pull requests from the CodeCommitReview pool`.:
```
aws codecommit update-approval-rule-template-description \
--approval-rule-template-name 1-approver-rule-for-all-pull-requests \
--approval-rule-template-description "Requires 1 approval for all pull requests from the CodeCommitReview pool"
```
Output:
```
{
"approvalRuleTemplate": {
"creationDate": 1571352720.773,
"approvalRuleTemplateDescription": "Requires 1 approval for all pull requests from the CodeCommitReview pool",
"lastModifiedDate": 1571358728.41,
"approvalRuleTemplateId": "41de97b7-EXAMPLE",
"approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
"ruleContentSha256": "2f6c21a5EXAMPLE",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Li_Juan"
}
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description) in the *AWS CodeCommit User Guide*.
+ For API details, see [UpdateApprovalRuleTemplateDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-description.html) in *AWS CLI Command Reference*.
### `update-approval-rule-template-name`
The following code example shows how to use `update-approval-rule-template-name`.
**AWS CLI**
**To update the name of an approval rule template**
The following `update-approval-rule-template-name` example changes the name of an approval rule template from `1-approver-rule` to 1-approver-rule-for-all-pull-requests`.
```
aws codecommit update-approval-rule-template-name \
--old-approval-rule-template-name 1-approver-rule \
--new-approval-rule-template-name 1-approver-rule-for-all-pull-requests
```
Output:
```
{
"approvalRuleTemplate": {
"approvalRuleTemplateName": "1-approver-rule-for-all-pull-requests",
"lastModifiedDate": 1571358241.619,
"approvalRuleTemplateId": "41de97b7-EXAMPLE",
"approvalRuleTemplateContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 1,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"creationDate": 1571352720.773,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"approvalRuleTemplateDescription": "All pull requests must be approved by one developer on the team.",
"ruleContentSha256": "2f6c21a5cEXAMPLE"
}
}
```
For more information, see [Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description) in the *AWS CodeCommit User Guide*.
+ For API details, see [UpdateApprovalRuleTemplateName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-name.html) in *AWS CLI Command Reference*.
### `update-comment`
The following code example shows how to use `update-comment`.
**AWS CLI**
**To update a comment on a commit**
This example demonstrates how to add the content `"Fixed as requested. I'll update the pull request."` to a comment with an ID of `442b498bEXAMPLE5756813`.
```
aws codecommit update-comment \
--comment-id 442b498bEXAMPLE5756813 \
--content "Fixed as requested. I'll update the pull request."
```
Output:
```
{
"comment": {
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "",
"commentId": "442b498bEXAMPLE5756813",
"content": "Fixed as requested. I'll update the pull request.",
"creationDate": 1508369929.783,
"deleted": false,
"lastModifiedDate": 1508369929.287,
"callerReactions": [],
"reactionCounts":
{
"THUMBSUP" : 2
}
}
}
```
+ For API details, see [UpdateComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-comment.html) in *AWS CLI Command Reference*.
### `update-default-branch`
The following code example shows how to use `update-default-branch`.
**AWS CLI**
**To change the default branch for a repository**
This example changes the default branch for an AWS CodeCommit repository. This command produces output only if there are errors.
Command:
```
aws codecommit update-default-branch --repository-name MyDemoRepo --default-branch-name MyNewBranch
```
Output:
```
None.
```
+ For API details, see [UpdateDefaultBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-default-branch.html) in *AWS CLI Command Reference*.
### `update-pull-request-approval-rule-content`
The following code example shows how to use `update-pull-request-approval-rule-content`.
**AWS CLI**
**To edit an approval rule for a pull request**
The following `update-pull-request-approval-rule-content` example updates she specified approval rule to require one user approval from an approval pool that includes any IAM user in the `123456789012` AWS account.
```
aws codecommit update-pull-request-approval-rule-content \
--pull-request-id 27 \
--approval-rule-name "Require two approved approvers" \
--approval-rule-content "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}"
```
Output:
```
{
"approvalRule": {
"approvalRuleContent": "{Version: 2018-11-08, Statements: [{Type: \"Approvers\", NumberOfApprovalsNeeded: 1, ApprovalPoolMembers:[\"CodeCommitApprovers:123456789012:user/*\"]}]}}",
"approvalRuleId": "aac33506-EXAMPLE",
"originApprovalRuleTemplate": {},
"creationDate": 1570752871.932,
"lastModifiedDate": 1570754058.333,
"approvalRuleName": Require two approved approvers",
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"ruleContentSha256": "cd93921cEXAMPLE",
}
}
```
For more information, see [Edit or Delete an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#update-pull-request-approval-rule-content) in the *AWS CodeCommit User Guide*.
+ For API details, see [UpdatePullRequestApprovalRuleContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-rule-content.html) in *AWS CLI Command Reference*.
### `update-pull-request-approval-state`
The following code example shows how to use `update-pull-request-approval-state`.
**AWS CLI**
**To approve or revoke approval for a pull request**
The following `update-pull-request-approval-state` example approves a pull request with the ID of `27` and a revision ID of `9f29d167EXAMPLE`. If you wanted to revoke approval instead, then set the `--approval-state` parameter value to `REVOKE`.
```
aws codecommit update-pull-request-approval-state \
--pull-request-id 27 \
--revision-id 9f29d167EXAMPLE \
--approval-state "APPROVE"
```
This command produces no output.
For more information, see [Review a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-review-pull-request.html#update-pull-request-approval-state) in the *AWS CodeCommit User Guide*.
+ For API details, see [UpdatePullRequestApprovalState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-state.html) in *AWS CLI Command Reference*.
### `update-pull-request-description`
The following code example shows how to use `update-pull-request-description`.
**AWS CLI**
**To change the description of a pull request**
This example demonstrates how to change the description of a pull request with the ID of `47`.
```
aws codecommit update-pull-request-description \
--pull-request-id 47 \
--description "Updated the pull request to remove unused global variable."
```
Output:
```
{
"pullRequest": {
"authorArn": "arn:aws:iam::111111111111:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.155,
"description": "Updated the pull request to remove unused global variable.",
"lastActivityDate": 1508372423.204,
"pullRequestId": "47",
"pullRequestStatus": "OPEN",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": false,
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables"
}
}
```
+ For API details, see [UpdatePullRequestDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-description.html) in *AWS CLI Command Reference*.
### `update-pull-request-status`
The following code example shows how to use `update-pull-request-status`.
**AWS CLI**
**To change the status of a pull request**
This example demonstrates how to to change the status of a pull request with the ID of `42` to a status of `CLOSED` in an AWS CodeCommit repository named `MyDemoRepo`.
```
aws codecommit update-pull-request-status \
--pull-request-id 42 \
--pull-request-status CLOSED
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approvers-needed-for-this-change",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.165,
"description": "Updated the pull request to remove unused global variable.",
"lastActivityDate": 1508372423.12,
"pullRequestId": "47",
"pullRequestStatus": "CLOSED",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": false,
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables"
}
}
```
+ For API details, see [UpdatePullRequestStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-status.html) in *AWS CLI Command Reference*.
### `update-pull-request-title`
The following code example shows how to use `update-pull-request-title`.
**AWS CLI**
**To change the title of a pull request**
This example demonstrates how to change the title of a pull request with the ID of `47`.
```
aws codecommit update-pull-request-title \
--pull-request-id 47 \
--title "Consolidation of global variables - updated review"
```
Output:
```
{
"pullRequest": {
"approvalRules": [
{
"approvalRuleContent": "{\"Version\": \"2018-11-08\",\"DestinationReferences\": [\"refs/heads/main\"],\"Statements\": [{\"Type\": \"Approvers\",\"NumberOfApprovalsNeeded\": 2,\"ApprovalPoolMembers\": [\"arn:aws:sts::123456789012:assumed-role/CodeCommitReview/*\"]}]}",
"approvalRuleId": "dd8b17fe-EXAMPLE",
"approvalRuleName": "2-approver-rule-for-main",
"creationDate": 1571356106.936,
"lastModifiedDate": 571356106.936,
"lastModifiedUser": "arn:aws:iam::123456789012:user/Mary_Major",
"originApprovalRuleTemplate": {
"approvalRuleTemplateId": "dd8b26gr-EXAMPLE",
"approvalRuleTemplateName": "2-approver-rule-for-main"
},
"ruleContentSha256": "4711b576EXAMPLE"
}
],
"authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
"clientRequestToken": "",
"creationDate": 1508530823.12,
"description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.",
"lastActivityDate": 1508372657.188,
"pullRequestId": "47",
"pullRequestStatus": "OPEN",
"pullRequestTargets": [
{
"destinationCommit": "9f31c968EXAMPLE",
"destinationReference": "refs/heads/main",
"mergeMetadata": {
"isMerged": false,
},
"repositoryName": "MyDemoRepo",
"sourceCommit": "99132ab0EXAMPLE",
"sourceReference": "refs/heads/variables-branch"
}
],
"title": "Consolidation of global variables - updated review"
}
}
```
+ For API details, see [UpdatePullRequestTitle](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-title.html) in *AWS CLI Command Reference*.
### `update-repository-description`
The following code example shows how to use `update-repository-description`.
**AWS CLI**
**To change the description for a repository**
This example changes the description for an AWS CodeCommit repository. This command produces output only if there are errors.
Command:
```
aws codecommit update-repository-description --repository-name MyDemoRepo --repository-description "This description was changed"
```
Output:
```
None.
```
+ For API details, see [UpdateRepositoryDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-description.html) in *AWS CLI Command Reference*.
### `update-repository-name`
The following code example shows how to use `update-repository-name`.
**AWS CLI**
**To change the name of a repository**
This example changes the name of an AWS CodeCommit repository. This command produces output only if there are errors. Changing the name of the AWS CodeCommit repository will change the SSH and HTTPS URLs that users need to connect to the repository. Users will not be able to connect to this repository until they update their connection settings. Also, because the repository's ARN will change, changing the repository name will invalidate any IAM user policies that rely on this repository's ARN.
Command:
```
aws codecommit update-repository-name --old-name MyDemoRepo --new-name MyRenamedDemoRepo
```
Output:
```
None.
```
+ For API details, see [UpdateRepositoryName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-name.html) in *AWS CLI Command Reference*.
# CodeDeploy examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodeDeploy.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `add-tags-to-on-premises-instances`
The following code example shows how to use `add-tags-to-on-premises-instances`.
**AWS CLI**
**To add tags to on-premises instances**
The following `add-tags-to-on-premises-instances` example associates in AWS CodeDeploy the same on-premises instance tag to two on-premises instances. It does not register the on-premises instances with AWS CodeDeploy.
```
aws deploy add-tags-to-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
This command produces no output.
+ For API details, see [AddTagsToOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/add-tags-to-on-premises-instances.html) in *AWS CLI Command Reference*.
### `batch-get-application-revisions`
The following code example shows how to use `batch-get-application-revisions`.
**AWS CLI**
**To retrieve information about application revisions**
The following `batch-get-application-revisions` example retrieves information about the specified revision stored in a GitHub repository.
```
aws deploy batch-get-application-revisions \
--application-name my-codedeploy-application \
--revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]"
```
Output:
```
{
"revisions": [
{
"genericRevisionInfo": {
"description": "Application revision registered by Deployment ID: d-A1B2C3111",
"lastUsedTime": 1556912355.884,
"registerTime": 1556912355.884,
"firstUsedTime": 1556912355.884,
"deploymentGroups": []
},
"revisionLocation": {
"revisionType": "GitHub",
"gitHubLocation": {
"commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE",
"repository": "my-github-token/my-repository"
}
}
}
],
"applicationName": "my-codedeploy-application",
"errorMessage": ""
}
```
For more information, see [BatchGetApplicationRevisions](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetApplicationRevisions.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [BatchGetApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-application-revisions.html) in *AWS CLI Command Reference*.
### `batch-get-applications`
The following code example shows how to use `batch-get-applications`.
**AWS CLI**
**To get information about multiple applications**
The following `batch-get-applications` example displays information about multiple applications that are associated with the user's AWS account.
```
aws deploy batch-get-applications --application-names WordPress_App MyOther_App
```
Output:
```
{
"applicationsInfo": [
{
"applicationName": "WordPress_App",
"applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE",
"createTime": 1407878168.078,
"linkedToGitHub": false
},
{
"applicationName": "MyOther_App",
"applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE",
"createTime": 1407453571.63,
"linkedToGitHub": false
}
]
}
```
+ For API details, see [BatchGetApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-applications.html) in *AWS CLI Command Reference*.
### `batch-get-deployment-groups`
The following code example shows how to use `batch-get-deployment-groups`.
**AWS CLI**
**To retrieve information about one or more deployment groups**
The following `batch-get-deployment-groups` example retrieves information about two of the deployment groups that are associated with the specified CodeDeploy application.
```
aws deploy batch-get-deployment-groups \
--application-name my-codedeploy-application \
--deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]"
```
Output:
```
{
"deploymentGroupsInfo": [
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"lastAttemptedDeployment": {
"endTime": 1556912366.415,
"status": "Failed",
"createTime": 1556912355.884,
"deploymentId": "d-A1B2C3111"
},
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-1",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
},
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-2",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
}
],
"errorMessage": ""
}
```
For more information, see [BatchGetDeploymentGroups](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentGroups.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [BatchGetDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-groups.html) in *AWS CLI Command Reference*.
### `batch-get-deployment-targets`
The following code example shows how to use `batch-get-deployment-targets`.
**AWS CLI**
**To retrieve the targets associated with a deployment**
The following `batch-get-deployment-targets` example returns information about one of the targets associated with the specified deployment.
```
aws deploy batch-get-deployment-targets \
--deployment-id "d-1A2B3C4D5" \
--target-ids "i-01a2b3c4d5e6f1111"
```
Output:
```
{
"deploymentTargets": [
{
"deploymentTargetType": "InstanceTarget",
"instanceTarget": {
"lifecycleEvents": [
{
"startTime": 1556918592.162,
"lifecycleEventName": "ApplicationStop",
"status": "Succeeded",
"endTime": 1556918592.247,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
},
{
"startTime": 1556918593.193,
"lifecycleEventName": "DownloadBundle",
"status": "Succeeded",
"endTime": 1556918593.981,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
},
{
"startTime": 1556918594.805,
"lifecycleEventName": "BeforeInstall",
"status": "Succeeded",
"endTime": 1556918681.807,
"diagnostics": {
"scriptName": "",
"errorCode": "Success",
"logTail": "",
"message": "Succeeded"
}
}
],
"targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111",
"deploymentId": "d-1A2B3C4D5",
"lastUpdatedAt": 1556918687.504,
"targetId": "i-01a2b3c4d5e6f1111",
"status": "Succeeded"
}
}
]
}
```
For more information, see [BatchGetDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentTargets.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [BatchGetDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-targets.html) in *AWS CLI Command Reference*.
### `batch-get-deployments`
The following code example shows how to use `batch-get-deployments`.
**AWS CLI**
**To get information about multiple deployments**
The following `batch-get-deployments` example displays information about multiple deployments that are associated with the user's AWS account.
```
aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222
```
Output:
```
{
"deploymentsInfo": [
{
"applicationName": "WordPress_App",
"status": "Failed",
"deploymentOverview": {
"Failed": 0,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 1,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"deploymentGroupName": "WordPress_DG",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
},
"deploymentId": "d-A1B2C3111",
"createTime": 1408480721.9,
"completeTime": 1408480741.822
},
{
"applicationName": "MyOther_App",
"status": "Failed",
"deploymentOverview": {
"Failed": 1,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 0,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"errorInformation": {
"message": "Deployment failed: Constraint default violated: No hosts succeeded.",
"code": "HEALTH_CONSTRAINTS"
},
"deploymentGroupName": "MyOther_DG",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"",
"bucket": "amzn-s3-demo-bucket",
"key": "MyOtherApp.zip"
}
},
"deploymentId": "d-A1B2C3222",
"createTime": 1409764576.589,
"completeTime": 1409764596.101
}
]
}
```
+ For API details, see [BatchGetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployments.html) in *AWS CLI Command Reference*.
### `batch-get-on-premises-instances`
The following code example shows how to use `batch-get-on-premises-instances`.
**AWS CLI**
**To get information about one or more on-premises instances**
The following `batch-get-on-premises-instances` example gets information about two on-premises instances.
```
aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX
```
Output:
```
{
"instanceInfos": [
{
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag12010298EX",
"registerTime": 1425579465.228,
"instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh"
},
{
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag23121309EX",
"registerTime": 1425595585.988,
"instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was"
}
]
}
```
+ For API details, see [BatchGetOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-on-premises-instances.html) in *AWS CLI Command Reference*.
### `continue-deployment`
The following code example shows how to use `continue-deployment`.
**AWS CLI**
**To start rerouting traffic without waiting for a specified wait time to elapse.**
The following `continue-deployment` example starts rerouting traffic from instances in the original environment that are ready to start shifting traffic to instances in the replacement environment.
```
aws deploy continue-deployment \
--deployment-id "d-A1B2C3111" \
--deployment-wait-type "READY_WAIT"
```
This command produces no output.
For more information, see [ContinueDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ContinueDeployment.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [ContinueDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/continue-deployment.html) in *AWS CLI Command Reference*.
### `create-application`
The following code example shows how to use `create-application`.
**AWS CLI**
**To create an application**
The following `create-application` example creates an application and associates it with the user's AWS account.
```
aws deploy create-application --application-name MyOther_App
```
Output:
```
{
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-application.html) in *AWS CLI Command Reference*.
### `create-deployment-config`
The following code example shows how to use `create-deployment-config`.
**AWS CLI**
**To create a custom deployment configuration**
The following `create-deployment-config` example creates a custom deployment configuration and associates it with the user's AWS account.
```
aws deploy create-deployment-config \
--deployment-config-name ThreeQuartersHealthy \
--minimum-healthy-hosts type=FLEET_PERCENT,value=75
```
Output:
```
{
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-config.html) in *AWS CLI Command Reference*.
### `create-deployment-group`
The following code example shows how to use `create-deployment-group`.
**AWS CLI**
**To create a deployment group**
The following `create-deployment-group` example creates a deployment group and associates it with the specified application and the user's AWS account.
```
aws deploy create-deployment-group \
--application-name WordPress_App \
--auto-scaling-groups CodeDeployDemo-ASG \
--deployment-config-name CodeDeployDefault.OneAtATime \
--deployment-group-name WordPress_DG \
--ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \
--service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole
```
Output:
```
{
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
}
```
+ For API details, see [CreateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-group.html) in *AWS CLI Command Reference*.
### `create-deployment`
The following code example shows how to use `create-deployment`.
**AWS CLI**
**Example 1: To create a CodeDeploy deployment using the EC2/On-premises compute platform**
The following `create-deployment` example creates a deployment and associates it with the user's AWS account.
```
aws deploy create-deployment \
--application-name WordPress_App \
--deployment-config-name CodeDeployDefault.OneAtATime \
--deployment-group-name WordPress_DG \
--description "My demo deployment" \
--s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
```
Output:
```
{
"deploymentId": "d-A1B2C3111"
}
```
**Example 2: To create a CodeDeploy deployment using the Amazon ECS compute platform**
The following `create-deployment` example uses the following two files to deploy an Amazon ECS service.
Contents of `create-deployment.json` file:
```
{
"applicationName": "ecs-deployment",
"deploymentGroupName": "ecs-deployment-dg",
"revision": {
"revisionType": "S3",
"s3Location": {
"bucket": "ecs-deployment-bucket",
"key": "appspec.yaml",
"bundleType": "YAML"
}
}
}
```
That file, in turn, retrieves the following file `appspec.yaml` from an S3 bucket called `ecs-deployment-bucket`.
```
version: 0.0
Resources:
- TargetService:
Type: AWS::ECS::Service
Properties:
TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2"
LoadBalancerInfo:
ContainerName: "sample-app"
ContainerPort: 80
PlatformVersion: "LATEST"
```
Command:
```
aws deploy create-deployment \
--cli-input-json file://create-deployment.json \
--region us-east-1
```
Output:
```
{
"deploymentId": "d-1234ABCDE"
}
```
For more information, see [CreateDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment.html) in *AWS CLI Command Reference*.
### `delete-application`
The following code example shows how to use `delete-application`.
**AWS CLI**
**To delete an application**
The following `delete-application` example deletes the specified application that is associated with the user's AWS account.
```
aws deploy delete-application --application-name WordPress_App
```
This command produces no output.
+ For API details, see [DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-application.html) in *AWS CLI Command Reference*.
### `delete-deployment-config`
The following code example shows how to use `delete-deployment-config`.
**AWS CLI**
**To delete a deployment configuration**
The following `delete-deployment-config` example deletes a custom deployment configuration that is associated with the user's AWS account.
```
aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy
```
This command produces no output.
+ For API details, see [DeleteDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-config.html) in *AWS CLI Command Reference*.
### `delete-deployment-group`
The following code example shows how to use `delete-deployment-group`.
**AWS CLI**
**To delete a deployment group**
The following `delete-deployment-group` example deletes a deployment group that is associated with the specified application.
```
aws deploy delete-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
Output:
```
{
"hooksNotCleanedUp": []
}
```
+ For API details, see [DeleteDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-group.html) in *AWS CLI Command Reference*.
### `delete-git-hub-account-token`
The following code example shows how to use `delete-git-hub-account-token`.
**AWS CLI**
**To deletes a GitHub account connection**
The following `delete-git-hub-account-token` example deletes the connection of the specified GitHub account.
```
aws deploy delete-git-hub-account-token --token-name my-github-account
```
Output:
```
{
"tokenName": "my-github-account"
}
```
For more information, see [DeleteGitHubAccountToken](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteGitHubAccountToken.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [DeleteGitHubAccountToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-git-hub-account-token.html) in *AWS CLI Command Reference*.
### `deregister-on-premises-instance`
The following code example shows how to use `deregister-on-premises-instance`.
**AWS CLI**
**To deregister an on-premises instance**
The following `deregister-on-premises-instance` example deregisters an on-premises instance with AWS CodeDeploy, but it does not delete the IAM user associated with the instance, nor does it disassociate in AWS CodeDeploy the on-premises instance tags from the instance. It also does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance.
```
aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX
```
This command produces no output.
+ For API details, see [DeregisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister-on-premises-instance.html) in *AWS CLI Command Reference*.
### `deregister`
The following code example shows how to use `deregister`.
**AWS CLI**
**To deregister an on-premises instance**
The following `deregister` example deregisters an on-premises instance with AWS CodeDeploy. It does not delete the IAM user that is associated with the instance. It disassociates in AWS CodeDeploy the on-premises tags from the instance. It does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance.
```
aws deploy deregister \
--instance-name AssetTag12010298EX \
--no-delete-iam-user \
--region us-west-2
```
Output:
```
Retrieving on-premises instance information... DONE
IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX
Tags: Key=Name,Value=CodeDeployDemo-OnPrem
Removing tags from the on-premises instance... DONE
Deregistering the on-premises instance... DONE
Run the following command on the on-premises instance to uninstall the codedeploy-agent:
aws deploy uninstall
```
+ For API details, see [Deregister](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister.html) in *AWS CLI Command Reference*.
### `get-application-revision`
The following code example shows how to use `get-application-revision`.
**AWS CLI**
**To get information about an application revision**
The following `get-application-revision` example displays information about an application revision that is associated with the specified application.
```
aws deploy get-application-revision \
--application-name WordPress_App \
--s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip
```
Output:
```
{
"applicationName": "WordPress_App",
"revisionInfo": {
"description": "Application revision registered by Deployment ID: d-A1B2C3111",
"registerTime": 1411076520.009,
"deploymentGroups": "WordPress_DG",
"lastUsedTime": 1411076520.009,
"firstUsedTime": 1411076520.009
},
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
}
}
```
+ For API details, see [GetApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application-revision.html) in *AWS CLI Command Reference*.
### `get-application`
The following code example shows how to use `get-application`.
**AWS CLI**
**To get information about an application**
The following `get-application` example displays information about an application that is associated with the user's AWS account.
```
aws deploy get-application --application-name WordPress_App
```
Output:
```
{
"application": {
"applicationName": "WordPress_App",
"applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"createTime": 1407878168.078,
"linkedToGitHub": false
}
}
```
+ For API details, see [GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application.html) in *AWS CLI Command Reference*.
### `get-deployment-config`
The following code example shows how to use `get-deployment-config`.
**AWS CLI**
**To get information about a deployment configuration**
The following `get-deployment-config` example displays information about a deployment configuration that is associated with the user's AWS account.
```
aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy
```
Output:
```
{
"deploymentConfigInfo": {
"deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"minimumHealthyHosts": {
"type": "FLEET_PERCENT",
"value": 75
},
"createTime": 1411081164.379,
"deploymentConfigName": "ThreeQuartersHealthy"
}
}
```
+ For API details, see [GetDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-config.html) in *AWS CLI Command Reference*.
### `get-deployment-group`
The following code example shows how to use `get-deployment-group`.
**AWS CLI**
**To view information about a deployment group**
The following `get-deployment-group` example displays information about a deployment group that is associated with the specified application.
```
aws deploy get-deployment-group \
--application-name WordPress_App \
--deployment-group-name WordPress_DG
```
Output:
```
{
"deploymentGroupInfo": {
"applicationName": "WordPress_App",
"autoScalingGroups": [
"CodeDeployDemo-ASG"
],
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"ec2TagFilters": [
{
"Type": "KEY_AND_VALUE",
"Value": "CodeDeployDemo",
"Key": "Name"
}
],
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole",
"deploymentGroupName": "WordPress_DG"
}
}
```
+ For API details, see [GetDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-group.html) in *AWS CLI Command Reference*.
### `get-deployment-instance`
The following code example shows how to use `get-deployment-instance`.
**AWS CLI**
**To get information about a deployment instance**
The following `get-deployment-instance` example displays information about a deployment instance that is associated with the specified deployment.
```
aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX
```
Output:
```
{
"instanceSummary": {
"instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX",
"lifecycleEvents": [
{
"status": "Succeeded",
"endTime": 1408480726.569,
"startTime": 1408480726.437,
"lifecycleEventName": "ApplicationStop"
},
{
"status": "Succeeded",
"endTime": 1408480728.016,
"startTime": 1408480727.665,
"lifecycleEventName": "DownloadBundle"
},
{
"status": "Succeeded",
"endTime": 1408480729.744,
"startTime": 1408480729.125,
"lifecycleEventName": "BeforeInstall"
},
{
"status": "Succeeded",
"endTime": 1408480730.979,
"startTime": 1408480730.844,
"lifecycleEventName": "Install"
},
{
"status": "Failed",
"endTime": 1408480732.603,
"startTime": 1408480732.1,
"lifecycleEventName": "AfterInstall"
},
{
"status": "Skipped",
"endTime": 1408480732.606,
"lifecycleEventName": "ApplicationStart"
},
{
"status": "Skipped",
"endTime": 1408480732.606,
"lifecycleEventName": "ValidateService"
}
],
"deploymentId": "d-QA4G4F9EX",
"lastUpdatedAt": 1408480733.152,
"status": "Failed"
}
}
```
+ For API details, see [GetDeploymentInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-instance.html) in *AWS CLI Command Reference*.
### `get-deployment-target`
The following code example shows how to use `get-deployment-target`.
**AWS CLI**
**To return information about a deployment target**
The following `get-deployment-target` example returns information about a deployment target that is associated with the specified deployment.
```
aws deploy get-deployment-target \
--deployment-id "d-A1B2C3111" \
--target-id "i-a1b2c3d4e5f611111"
```
Output:
```
{
"deploymentTarget": {
"deploymentTargetType": "InstanceTarget",
"instanceTarget": {
"lastUpdatedAt": 1556918687.504,
"targetId": "i-a1b2c3d4e5f611111",
"targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111",
"status": "Succeeded",
"lifecycleEvents": [
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ApplicationStop",
"startTime": 1556918592.162,
"endTime": 1556918592.247
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "DownloadBundle",
"startTime": 1556918593.193,
"endTime": 1556918593.981
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "BeforeInstall",
"startTime": 1556918594.805,
"endTime": 1556918681.807
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "Install",
"startTime": 1556918682.696,
"endTime": 1556918683.005
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "AfterInstall",
"startTime": 1556918684.135,
"endTime": 1556918684.216
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ApplicationStart",
"startTime": 1556918685.211,
"endTime": 1556918685.295
},
{
"status": "Succeeded",
"diagnostics": {
"errorCode": "Success",
"message": "Succeeded",
"logTail": "",
"scriptName": ""
},
"lifecycleEventName": "ValidateService",
"startTime": 1556918686.65,
"endTime": 1556918686.747
}
],
"deploymentId": "d-A1B2C3111"
}
}
}
```
For more information, see [GetDeploymentTarget](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeploymentTarget.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [GetDeploymentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-target.html) in *AWS CLI Command Reference*.
### `get-deployment`
The following code example shows how to use `get-deployment`.
**AWS CLI**
**To get information about a deployment**
The following `get-deployment` example displays information about a deployment that is associated with the user's AWS account.
```
aws deploy get-deployment --deployment-id d-A1B2C3123
```
Output:
```
{
"deploymentInfo": {
"applicationName": "WordPress_App",
"status": "Succeeded",
"deploymentOverview": {
"Failed": 0,
"InProgress": 0,
"Skipped": 0,
"Succeeded": 1,
"Pending": 0
},
"deploymentConfigName": "CodeDeployDefault.OneAtATime",
"creator": "user",
"description": "My WordPress app deployment",
"revision": {
"revisionType": "S3",
"s3Location": {
"bundleType": "zip",
"eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPressApp.zip"
}
},
"deploymentId": "d-A1B2C3123",
"deploymentGroupName": "WordPress_DG",
"createTime": 1409764576.589,
"completeTime": 1409764596.101,
"ignoreApplicationStopFailures": false
}
}
```
+ For API details, see [GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment.html) in *AWS CLI Command Reference*.
### `get-on-premises-instance`
The following code example shows how to use `get-on-premises-instance`.
**AWS CLI**
**To get information about an on-premises instance**
The following `get-on-premises-instance` example retrieves information about the specified on-premises instance.
```
aws deploy get-on-premises-instance --instance-name AssetTag12010298EX
```
Output:
```
{
"instanceInfo": {
"iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX",
"tags": [
{
"Value": "CodeDeployDemo-OnPrem",
"Key": "Name"
}
],
"instanceName": "AssetTag12010298EX",
"registerTime": 1425579465.228,
"instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh"
}
}
```
+ For API details, see [GetOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-on-premises-instance.html) in *AWS CLI Command Reference*.
### `install`
The following code example shows how to use `install`.
**AWS CLI**
**To install an on-premises instance**
The following `install` example copies the on-premises configuration file from the specified location on the instance to the location on the instance that the AWS CodeDeploy Agent expects to find it. It also installs the AWS CodeDeploy Agent on the instance. It does not create any IAM user, nor register the on-premises instance with AWS CodeDeploy, nor associate any on-premises instance tags in AWS CodeDeploy for the instance.
```
aws deploy install \
--override-config \
--config-file C:\temp\codedeploy.onpremises.yml \
--region us-west-2 \
--agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi
```
Output:
```
Creating the on-premises instance configuration file... DONE
Installing the AWS CodeDeploy Agent... DONE
```
+ For API details, see [Install](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/install.html) in *AWS CLI Command Reference*.
### `list-application-revisions`
The following code example shows how to use `list-application-revisions`.
**AWS CLI**
**To get information about application revisions**
The following `list-application-revisions` example displays information about all application revisions that are associated with the specified application.
```
aws deploy list-application-revisions \
--application-name WordPress_App \
--s-3-bucket amzn-s3-demo-bucket \
--deployed exclude \
--s-3-key-prefix WordPress_ \
--sort-by lastUsedTime \
--sort-order descending
```
Output:
```
{
"revisions": [
{
"revisionType": "S3",
"s3Location": {
"version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPress_App.zip",
"bundleType": "zip"
}
},
{
"revisionType": "S3",
"s3Location": {
"version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE",
"bucket": "amzn-s3-demo-bucket",
"key": "WordPress_App_2-0.zip",
"bundleType": "zip"
}
}
]
}
```
+ For API details, see [ListApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-application-revisions.html) in *AWS CLI Command Reference*.
### `list-applications`
The following code example shows how to use `list-applications`.
**AWS CLI**
**To get information about applications**
The following `list-applications` example displays information about all applications that are associated with the user's AWS account.
```
aws deploy list-applications
```
Output:
```
{
"applications": [
"WordPress_App",
"MyOther_App"
]
}
```
+ For API details, see [ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-applications.html) in *AWS CLI Command Reference*.
### `list-deployment-configs`
The following code example shows how to use `list-deployment-configs`.
**AWS CLI**
**To get information about deployment configurations**
The following `list-deployment-configs` example displays information about all deployment configurations that are associated with the user's AWS account.
```
aws deploy list-deployment-configs
```
Output:
```
{
"deploymentConfigsList": [
"ThreeQuartersHealthy",
"CodeDeployDefault.AllAtOnce",
"CodeDeployDefault.HalfAtATime",
"CodeDeployDefault.OneAtATime"
]
}
```
+ For API details, see [ListDeploymentConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-configs.html) in *AWS CLI Command Reference*.
### `list-deployment-groups`
The following code example shows how to use `list-deployment-groups`.
**AWS CLI**
**To get information about deployment groups**
The following `list-deployment-groups` example displays information about all deployment groups that are associated with the specified application.
```
aws deploy list-deployment-groups --application-name WordPress_App
```
Output:
```
{
"applicationName": "WordPress_App",
"deploymentGroups": [
"WordPress_DG",
"WordPress_Beta_DG"
]
}
```
+ For API details, see [ListDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-groups.html) in *AWS CLI Command Reference*.
### `list-deployment-instances`
The following code example shows how to use `list-deployment-instances`.
**AWS CLI**
**To get information about deployment instances**
The following `list-deployment-instances` example displays information about all deployment instances that are associated with the specified deployment.
```
aws deploy list-deployment-instances \
--deployment-id d-A1B2C3111 \
--instance-status-filter Succeeded
```
Output:
```
{
"instancesList": [
"i-EXAMPLE11",
"i-EXAMPLE22"
]
}
```
+ For API details, see [ListDeploymentInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-instances.html) in *AWS CLI Command Reference*.
### `list-deployment-targets`
The following code example shows how to use `list-deployment-targets`.
**AWS CLI**
**To retrieve a list of target IDs that are associated with a deployment**
The following `list-deployment-targets` example retrieves a list of target IDs associated with deployments that have a status of "Failed" or "InProgress."
```
aws deploy list-deployment-targets \
--deployment-id "d-A1B2C3111" \
--target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}"
```
Output:
```
{
"targetIds": [
"i-0f1558aaf90e5f1f9"
]
}
```
For more information, see [ListDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListDeploymentTargets.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [ListDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-targets.html) in *AWS CLI Command Reference*.
### `list-deployments`
The following code example shows how to use `list-deployments`.
**AWS CLI**
**To get information about deployments**
The following `list-deployments` example displays information about all deployments that are associated with the specified application and deployment group.
```
aws deploy list-deployments \
--application-name WordPress_App \
--create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \
--deployment-group-name WordPress_DG \
--include-only-statuses Failed
```
Output:
```
{
"deployments": [
"d-EXAMPLE11",
"d-EXAMPLE22",
"d-EXAMPLE33"
]
}
```
+ For API details, see [ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployments.html) in *AWS CLI Command Reference*.
### `list-git-hub-account-token-names`
The following code example shows how to use `list-git-hub-account-token-names`.
**AWS CLI**
**To lists the names of stored connections to GitHub accounts**
The following `list-git-hub-account-token-names` example lists the names of the stored connections to GitHub accounts for the current AWS user.
```
aws deploy list-git-hub-account-token-names
```
Output:
```
{
"tokenNameList": [
"my-first-token",
"my-second-token",
"my-third-token"
]
}
```
For more information, see [ListGitHubAccountTokenNames](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListGitHubAccountTokenNames.html) in the *AWS CodeDeploy API Reference*.
+ For API details, see [ListGitHubAccountTokenNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-git-hub-account-token-names.html) in *AWS CLI Command Reference*.
### `list-on-premises-instances`
The following code example shows how to use `list-on-premises-instances`.
**AWS CLI**
**To get information about one or more on-premises instances**
The following `list-on-premises-instances` example retrieves a list of available on-premises instance names for instances that are registered in AWS CodeDeploy and also have the specified on-premises instance tag associated in AWS CodeDeploy with the instance.
```
aws deploy list-on-premises-instances \
--registration-status Registered \
--tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE
```
Output:
```
{
"instanceNames": [
"AssetTag12010298EX"
]
}
```
+ For API details, see [ListOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-on-premises-instances.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list tags for a resource (application)**
The following `list-tags-for-resource` example lists the tags applied to an application named testApp in CodeDeploy.
```
aws deploy list-tags-for-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp
```
Output:
```
{
"Tags": [
{
"Key": "Type",
"Value": "testType"
},
{
"Key": "Name",
"Value": "testName"
}
]
}
```
For more information, see [Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `push`
The following code example shows how to use `push`.
**AWS CLI**
**To bundle and deploy an AWS CodeDeploy compatible application revision to Amazon S3**
The following `push` example bundles and deploys an application revision to Amazon S3 and then associates the application revision with the specified application.
```
aws deploy push \
--application-name WordPress_App \
--description "This is my deployment" \
--ignore-hidden-files \
--s3-location s3://amzn-s3-demo-bucket/WordPressApp.zip \
--source /tmp/MyLocalDeploymentFolder/
```
The output describes how to use the `create-deployment` command to create a deployment that uses the uploaded application revision.
```
To deploy with this revision, run:
aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=amzn-s3-demo-bucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE
```
+ For API details, see [Push](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/push.html) in *AWS CLI Command Reference*.
### `register-application-revision`
The following code example shows how to use `register-application-revision`.
**AWS CLI**
**To register information about an already-uploaded application revision**
The following `register-application-revision` example registers information about an already-uploaded application revision stored in Amazon S3 with AWS CodeDeploy.
```
aws deploy register-application-revision \
--application-name WordPress_App \
--description "Revised WordPress application" \
--s3-location bucket=amzn-s3-demo-bucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE
```
This command produces no output.
+ For API details, see [RegisterApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-application-revision.html) in *AWS CLI Command Reference*.
### `register-on-premises-instance`
The following code example shows how to use `register-on-premises-instance`.
**AWS CLI**
**To register an on-premises instance**
The following `register-on-premises-instance` example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance.
```
aws deploy register-on-premises-instance \
--instance-name AssetTag12010298EX \
--iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem
```
This command produces no output.
+ For API details, see [RegisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-on-premises-instance.html) in *AWS CLI Command Reference*.
### `register`
The following code example shows how to use `register`.
**AWS CLI**
**To register an on-premises instance**
The following `register` example registers an on-premises instance with AWS CodeDeploy, associates in AWS CodeDeploy the specified on-premises instance tag with the registered instance, and creates an on-premises configuration file that can be copied to the instance. It does not create the IAM user, nor does it install the AWS CodeDeploy Agent on the instance.
```
aws deploy register \
--instance-name AssetTag12010298EX \
--iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \
--tags Key=Name,Value=CodeDeployDemo-OnPrem \
--region us-west-2
```
Output:
```
Registering the on-premises instance... DONE
Adding tags to the on-premises instance... DONE
Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent:
aws deploy install --config-file codedeploy.onpremises.yml
```
+ For API details, see [Register](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register.html) in *AWS CLI Command Reference*.
### `remove-tags-from-on-premises-instances`
The following code example shows how to use `remove-tags-from-on-premises-instances`.
**AWS CLI**
**To remove tags from one or more on-premises instances**
The following `remove-tags-from-on-premises-instances` example disassociates the specified on-premises tags in AWS CodeDeploy from on-premises instances. It does not deregister the on-premises instances in AWS CodeDeploy, nor uninstall the AWS CodeDeploy Agent from the instance, nor remove the on-premises configuration file from the instances, nor delete the IAM users that are associated with the instances.
```
aws deploy remove-tags-from-on-premises-instances \
--instance-names AssetTag12010298EX AssetTag23121309EX \
--tags Key=Name,Value=CodeDeployDemo-OnPrem
```
This command produces no output.
+ For API details, see [RemoveTagsFromOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/remove-tags-from-on-premises-instances.html) in *AWS CLI Command Reference*.
### `stop-deployment`
The following code example shows how to use `stop-deployment`.
**AWS CLI**
**To attempt to stop a deployment**
The following `stop-deployment` example attempts to stop an in-progress deployment that is associated with the user's AWS account.
aws deploy stop-deployment --deployment-id d-A1B2C3111
Output:
```
{
"status": "Succeeded",
"statusMessage": "No more commands will be scheduled for execution in the deployment instances"
}
```
+ For API details, see [StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/stop-deployment.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To tag a resource (application)**
The following `tag-resource` example adds two tags with keys Name and Type, and values testName and testType to an application named testApp in CodeDeploy.:
```
aws deploy tag-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
--tags Key=Name,Value=testName Key=Type,Value=testType
```
If successful, this command produces no output.
For more information, see [Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/tag-resource.html) in *AWS CLI Command Reference*.
### `uninstall`
The following code example shows how to use `uninstall`.
**AWS CLI**
**To uninstall an on-premises instance**
The following `uninstall` example uninstalls the AWS CodeDeploy Agent from the on-premises instance and removes the on-premises configuration file from the instance. It doesn't deregister the instance in AWS CodeDeploy, nor disassociate any on-premises instance tags in AWS CodeDeploy from the instance, nor delete the IAM user that is associated with the instance.
```
aws deploy uninstall
```
This command produces no output.
+ For API details, see [Uninstall](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/uninstall.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove tags from a resource (application)**
The following `untag-resource` example removes two tags with keys Name and Type from an application named testApp in CodeDeploy.
```
aws deploy untag-resource \
--resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \
--tag-keys Name Type
```
If successful, this command produces no output.
For more information, see [Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html) in the *AWS CodeDeploy User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/untag-resource.html) in *AWS CLI Command Reference*.
### `update-application`
The following code example shows how to use `update-application`.
**AWS CLI**
**To change details of an application**
The following `update-application` example changes the name of an application that is associated with the user's AWS account.
```
aws deploy update-application \
--application-name WordPress_App \
--new-application-name My_WordPress_App
```
This command produces no output.
+ For API details, see [UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-application.html) in *AWS CLI Command Reference*.
### `update-deployment-group`
The following code example shows how to use `update-deployment-group`.
**AWS CLI**
**To change information about a deployment group**
The following `update-deployment-group` example changes the settings of a deployment group that is associated with the specified application.
```
aws deploy update-deployment-group \
--application-name WordPress_App \
--auto-scaling-groups My_CodeDeployDemo_ASG \
--current-deployment-group-name WordPress_DG \
--deployment-config-name CodeDeployDefault.AllAtOnce \
--ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \
--new-deployment-group-name My_WordPress_DepGroup \
--service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2
```
This command produces no output.
+ For API details, see [UpdateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-deployment-group.html) in *AWS CLI Command Reference*.
# CodeGuru Reviewer examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodeGuru Reviewer.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `associate-repository`
The following code example shows how to use `associate-repository`.
**AWS CLI**
**Example 1: To create a Bitbucket repository association**
The following `associate-repository` example creates a repository association using an existing Bitbucket repository.
```
aws codeguru-reviewer associate-repository \
--repository 'Bitbucket={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'
```
Output:
```
{
"RepositoryAssociation": {
"ProviderType": "Bitbucket",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596216896.979,
"AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "sample-owner"
}
}
```
For more information, see [Create a Bitbucket repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-bitbucket-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
**Example 2: To create a GitHub Enterprise repository association**
The following `associate-repository` example creates a repository association using an existing GitHub Enterprise repository.
```
aws codeguru-reviewer associate-repository \
--repository 'GitHubEnterpriseServer={Owner=sample-owner, Name=mySampleRepo, ConnectionArn=arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 }'
```
Output:
```
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596216896.979,
"AssociationId": "association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "sample-owner"
}
}
```
For more information, see [Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon Codeguru Reviewer User Guide*.
**Example 3: To create an AWS CodeCommit repository association**
The following `associate-repository` example creates a repository association using an existing AWS CodeCommit repository.
```
aws codeguru-reviewer associate-repository \
--repository CodeCommit={Name=mySampleRepo}
```
Output:
```
{
"RepositoryAssociation": {
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Name": "My-ecs-beta-repo",
"LastUpdatedTimeStamp": 1595634764.029,
"ProviderType": "CodeCommit",
"CreatedTimeStamp": 1595634764.029,
"Owner": "544120495673",
"State": "Associating",
"StateReason": "Pending Repository Association",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:544120495673:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
```
For more information, see [Create an AWS CodeCommit repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-codecommit-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [AssociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/associate-repository.html) in *AWS CLI Command Reference*.
### `create-code-review`
The following code example shows how to use `create-code-review`.
**AWS CLI**
**To create a code review.**
The following `create-code-review` creates a review of code in the `mainline` branch of an AWS CodeCommit repository that is named `my-repository-name`.
```
aws codeguru-reviewer create-code-review \
--name my-code-review \
--repository-association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--type '{"RepositoryAnalysis": {"RepositoryHead": {"BranchName": "mainline"}}}'
```
Output:
```
{
"CodeReview": {
"Name": "my-code-review",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-code-review",
"RepositoryName": "my-repository-name",
"Owner": "123456789012",
"ProviderType": "CodeCommit",
"State": "Pending",
"StateReason": "CodeGuru Reviewer has received the request, and a code review is scheduled.",
"CreatedTimeStamp": 1618873489.195,
"LastUpdatedTimeStamp": 1618873489.195,
"Type": "RepositoryAnalysis",
"SourceCodeType": {
"RepositoryHead": {
"BranchName": "mainline"
}
},
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
```
For more information, see [Create code reviews in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-code-reviews.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [CreateCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/create-code-review.html) in *AWS CLI Command Reference*.
### `describe-code-review`
The following code example shows how to use `describe-code-review`.
**AWS CLI**
**List details about a code review.**
The following `describe-code-review` lists information about a review of code in the "mainline" branch of an AWS CodeCommit repository that is named "my-repo-name".
```
aws codeguru-reviewer put-recommendation-feedback \
--code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
--recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \
--reactions ThumbsUp
```
Output
```
{
"CodeReview": {
"Name": "My-ecs-beta-repo-master-xs6di4kfd4j269dz",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222:code-review:RepositoryAnalysis-my-repo-name",
"RepositoryName": "My-ecs-beta-repo",
"Owner": "123456789012",
"ProviderType": "CodeCommit",
"State": "Pending",
"StateReason": "CodeGuru Reviewer is reviewing the source code.",
"CreatedTimeStamp": 1618874226.226,
"LastUpdatedTimeStamp": 1618874233.689,
"Type": "RepositoryAnalysis",
"SourceCodeType": {
"RepositoryHead": {
"BranchName": "mainline"
}
},
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
```
For more information, see [View code review details](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-code-review-details.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [DescribeCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-code-review.html) in *AWS CLI Command Reference*.
### `describe-recommendation-feedback`
The following code example shows how to use `describe-recommendation-feedback`.
**AWS CLI**
**To view information about feedback on a recommendation**
The following `describe-recommendation-feedback` displays information about feedback on a recommendation. This recommendation has one `ThumbsUp` reaction.
```
aws codeguru-reviewer describe-recommendation-feedback \
--code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
--recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb
```
Output:
```
{
"RecommendationFeedback": {
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678",
"RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb",
"Reactions": [
"ThumbsUp"
],
"UserId": "aws-user-id",
"CreatedTimeStamp": 1618877070.313,
"LastUpdatedTimeStamp": 1618877948.881
}
}
```
For more information, see [View recommendations and provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/give-feedback-from-code-review-details.html) and [Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [DescribeRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-recommendation-feedback.html) in *AWS CLI Command Reference*.
### `describe-repository-association`
The following code example shows how to use `describe-repository-association`.
**AWS CLI**
**Example 1: To return information about a GitHub repository association**
The following `describe-repository-association` example returns information about a repository association that uses a GitHub Enterprise repository and is in the `Associated` state.
```
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RepositoryAssociation": {
"AssociationId": "b822717e-0711-4e8a-bada-0e738289c75e",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1588102637.649,
"ProviderType": "GitHub",
"CreatedTimeStamp": 1588102615.636,
"Owner": "sample-owner",
"State": "Associated",
"StateReason": "Pull Request Notification configuration successful",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
}
```
For more information, see [Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
**Example 2: To return information about a failed repository association**
The following `describe-repository-association` example returns information about a repository association that uses a GitHub Enterprise repository and is in the `Failed` state.
```
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596217036.892,
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"State": "Failed",
"StateReason": "Failed, Please retry.",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "sample-owner"
}
}
```
For more information, see [Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
**Example 3: To return information about a disassociating repository association**
The following `describe-repository-association` example returns information about a repository association that uses a GitHub Enterprise repository and is in the `Disassociating` state.
```
aws codeguru-reviewer describe-repository-association \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RepositoryAssociation": {
"ProviderType": "GitHubEnterpriseServer",
"Name": "mySampleRepo",
"LastUpdatedTimeStamp": 1596217036.892,
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"CreatedTimeStamp": 1596216896.979,
"ConnectionArn": "arn:aws:codestar-connections:us-west-2:123456789012:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"State": "Disassociating",
"StateReason": "Source code access removal in progress",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "sample-owner"
}
}
```
For more information, see [Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [DescribeRepositoryAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-repository-association.html) in *AWS CLI Command Reference*.
### `disassociate-repository`
The following code example shows how to use `disassociate-repository`.
**AWS CLI**
**To disassociate a repository association**
The following `disassociate-repository` disassociates a repository association that is using an AWS CodeCommit repository.
```
aws codeguru-reviewer disassociate-repository \
--association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RepositoryAssociation": {
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Name": "my-repository",
"Owner": "123456789012",
"ProviderType": "CodeCommit",
"State": "Disassociating",
"LastUpdatedTimeStamp": 1618939174.759,
"CreatedTimeStamp": 1595636947.096
},
"Tags": {
"Status": "Secret",
"Team": "Saanvi"
}
}
```
For more information, see [Disassociate a repository in CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/disassociate-repository-association.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [DisassociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/disassociate-repository.html) in *AWS CLI Command Reference*.
### `list-code-reviews`
The following code example shows how to use `list-code-reviews`.
**AWS CLI**
**To list code reviews created in your AWS account in the last 90 days.**
The following `list-code-reviews` example lists the code reviews created in the last 90 days using pull requests.
```
aws codeguru-reviewer list-code-reviews \
--type PullRequest
```
Output:
```
{
"CodeReviewSummaries": [
{
"LastUpdatedTimeStamp": 1588897288.054,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"ProviderType": "GitHub",
"PullRequestId": "5",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 24,
"FindingsCount": 1
},
"CreatedTimeStamp": 1588897068.512,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
},
{
"LastUpdatedTimeStamp": 1588869793.263,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"ProviderType": "GitHub",
"PullRequestId": "4",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 29,
"FindingsCount": 0
},
"CreatedTimeStamp": 1588869575.949,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
},
{
"LastUpdatedTimeStamp": 1588870511.211,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"ProviderType": "GitHub",
"PullRequestId": "4",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 2,
"FindingsCount": 0
},
"CreatedTimeStamp": 1588870292.425,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
},
{
"LastUpdatedTimeStamp": 1588118522.452,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"ProviderType": "GitHub",
"PullRequestId": "3",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 29,
"FindingsCount": 0
},
"CreatedTimeStamp": 1588118301.131,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
},
{
"LastUpdatedTimeStamp": 1588112205.207,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
"ProviderType": "GitHub",
"PullRequestId": "2",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 25,
"FindingsCount": 0
},
"CreatedTimeStamp": 1588111987.443,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
},
{
"LastUpdatedTimeStamp": 1588104489.981,
"Name": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
"ProviderType": "GitHub",
"PullRequestId": "1",
"MetricsSummary": {
"MeteredLinesOfCodeCount": 25,
"FindingsCount": 0
},
"CreatedTimeStamp": 1588104270.223,
"State": "Completed",
"CodeReviewArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
"Owner": "sample-owner",
"RepositoryName": "sample-repository-name",
"Type": "PullRequest"
}
]
}
```
For more information, see [View all code reviews](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-all-code-reviews.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [ListCodeReviews](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-code-reviews.html) in *AWS CLI Command Reference*.
### `list-recommendation-feedback`
The following code example shows how to use `list-recommendation-feedback`.
**AWS CLI**
**To list customer recommendation feedback for a recommendation on an associated repository**
The following `list-recommendation-feedback` Lists customer feedback on all recommendations on a code review. This code review has one piece of feedback, a "ThumbsUp", from a customer.
```
aws codeguru-reviewer list-recommendation-feedback \
--code-review-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678
```
Output:
```
{
"RecommendationFeedbackSummaries": [
{
"RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb",
"Reactions": [
"ThumbsUp"
],
"UserId": "aws-user-id"
}
]
}
```
For more information, see [Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [ListRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendation-feedback.html) in *AWS CLI Command Reference*.
### `list-recommendations`
The following code example shows how to use `list-recommendations`.
**AWS CLI**
**To list the recommendations for a completed code review**
The following `list-recommendations` example lists the recommendations for a completed code review. This code review has one recommendations.
```
aws codeguru-reviewer list-recommendations \
--code-review-arn arn:aws:codeguru-reviewer:us-west-2:544120495673:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RecommendationSummaries": [
{
"Description": "\n\n**Problem** \n You are using a `ConcurrentHashMap`, but your usage of `containsKey()` and `get()` may not be thread-safe at lines: **63 and 64**. In between the check and the `get()` another thread can remove the key and the `get()` will return `null`. The remove that can remove the key is at line: **59**.\n\n**Fix** \n Consider calling `get()`, checking instead of your current check if the returned object is `null`, and then using that object only, without calling `get()` again.\n\n**More info** \n [View an example on GitHub](https://github.com/apache/hadoop/blob/f16cf877e565084c66bc63605659b157c4394dc8/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3Guard.java#L302-L304) (external link).",
"RecommendationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"StartLine": 63,
"EndLine": 64,
"FilePath": "src/main/java/com/company/sample/application/CreateOrderThread.java"
}
]
}
```
For more information, see [Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [ListRecommendations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendations.html) in *AWS CLI Command Reference*.
### `list-repository-associations`
The following code example shows how to use `list-repository-associations`.
**AWS CLI**
**To list the repository associations in your AWS account**
The following `list-repository-associations` example returns a list of repository association summary objects in your account. You can filter the returned list by `ProviderType`, `Name`, `State`, and `Owner`.
```
aws codeguru-reviewer list-repository-associations
```
Output:
```
{
"RepositoryAssociationSummaries": [
{
"LastUpdatedTimeStamp": 1595886609.616,
"Name": "test",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Owner": "sample-owner",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"ProviderType": "Bitbucket"
},
{
"LastUpdatedTimeStamp": 1595636969.035,
"Name": "CodeDeploy-CodePipeline-ECS-Tutorial",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Owner": "123456789012",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"ProviderType": "CodeCommit"
},
{
"LastUpdatedTimeStamp": 1595634785.983,
"Name": "My-ecs-beta-repo",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"Owner": "123456789012",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
"ProviderType": "CodeCommit"
},
{
"LastUpdatedTimeStamp": 1590712811.77,
"Name": "MyTestCodeCommit",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"Owner": "123456789012",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
"ProviderType": "CodeCommit"
},
{
"LastUpdatedTimeStamp": 1588102637.649,
"Name": "aws-codeguru-profiler-sample-application",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
"Owner": "sample-owner",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE55555",
"ProviderType": "GitHub"
},
{
"LastUpdatedTimeStamp": 1588028233.995,
"Name": "codeguru-profiler-demo-app",
"AssociationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
"Owner": "sample-owner",
"State": "Associated",
"AssociationArn": "arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE66666",
"ProviderType": "GitHub"
}
]
}
```
For more information, see [View all repository associations in CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/repository-association-view-all.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [ListRepositoryAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-repository-associations.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list the tags on an associated repository**
The following `list-tags-for-resource` lists the tags on an associated repository. This associated repository has two tags.
```
aws codeguru-reviewer list-tags-for-resource \
--resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"Tags": {
"Status": "Secret",
"Team": "Saanvi"
}
}
```
For more information, see [View tags for a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-view-cli.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `put-recommendation-feedback`
The following code example shows how to use `put-recommendation-feedback`.
**AWS CLI**
**To add a recommendation to a code review**
The following `put-recommendation-feedback` puts a `ThumbsUp` recommendation on a code review.
```
aws codeguru-reviewer put-recommendation-feedback \
--code-review-arn \arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:code-review:RepositoryAnalysis-my-repository-name-branch-abcdefgh12345678 \
--recommendation-id 3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb \
--reactions ThumbsUp
```
This command produces no output.
For more information, see [Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [PutRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/put-recommendation-feedback.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To add a tag to an associated repository**
The following `tag-resource` adds two tags to an associated repository
```
aws codeguru-reviewer tag-resource \
--resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--tags Status=Secret,Team=Saanvi
```
This command produces no output.
For more information, see [Add a tag to a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-add-cli.html) and [Add or update tags for a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-update-cli.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To untag an associated repository**
The following `untag-resource` removes two tags with keys "Secret" and "Team" from an associated repository.
```
aws codeguru-reviewer untag-resource \
--resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--tag-keys Status Team
```
This command produces no output.
For more information, see [Remove tags from a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-remove-cli.html) in the *Amazon CodeGuru Reviewer User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/untag-resource.html) in *AWS CLI Command Reference*.
# CodePipeline examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodePipeline.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `acknowledge-job`
The following code example shows how to use `acknowledge-job`.
**AWS CLI**
**To retrieve information about a specified job**
This example returns information about a specified job, including the status of that job if it exists. This is only used for job workers and custom actions. To determine the value of nonce and the job ID, use aws codepipeline poll-for-jobs.
Command:
```
aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3
```
Output:
```
{
"status": "InProgress"
}
```
+ For API details, see [AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html) in *AWS CLI Command Reference*.
### `create-custom-action-type`
The following code example shows how to use `create-custom-action-type`.
**AWS CLI**
**To create a custom action**
This example creates a custom action for AWS CodePipeline using an already-created JSON file (here named MyCustomAction.json) that contains the structure of the custom action. For more information about the requirements for creating a custom action, including the structure of the file, see the AWS CodePipeline User Guide.
```
aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json
```
Contents of JSON file `MyCustomAction.json`:
```
{
"category": "Build",
"provider": "MyJenkinsProviderName",
"version": "1",
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
},
"configurationProperties": [
{
"name": "MyJenkinsExampleBuildProject",
"required": true,
"key": true,
"secret": false,
"queryable": false,
"description": "The name of the build project must be provided when this action is added to the pipeline.",
"type": "String"
}
],
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
}
}
```
This command returns the structure of the custom action.
+ For API details, see [CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html) in *AWS CLI Command Reference*.
### `create-pipeline`
The following code example shows how to use `create-pipeline`.
**AWS CLI**
**To create a pipeline**
This example creates a pipeline in AWS CodePipeline using an already-created JSON file (here named MySecondPipeline.json) that contains the structure of the pipeline. For more information about the requirements for creating a pipeline, including the structure of the file, see the AWS CodePipeline User Guide.
Command:
```
aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json
```
JSON file sample contents:
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MySecondPipeline",
"version": 1
}
}
```
Output:
```
This command returns the structure of the pipeline.
```
+ For API details, see [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html) in *AWS CLI Command Reference*.
### `delete-custom-action-type`
The following code example shows how to use `delete-custom-action-type`.
**AWS CLI**
**To delete a custom action**
This example deletes a custom action in AWS CodePipeline by using an already-created JSON file (here named DeleteMyCustomAction.json) that contains the action type, provider name, and version number of the action to be deleted. Use the list-action-types command to view the correct values for category, version, and provider.
Command:
```
aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json
```
JSON file sample contents:
```
{
"category": "Build",
"version": "1",
"provider": "MyJenkinsProviderName"
}
```
Output:
```
None.
```
+ For API details, see [DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html) in *AWS CLI Command Reference*.
### `delete-pipeline`
The following code example shows how to use `delete-pipeline`.
**AWS CLI**
**To delete a pipeline**
This example deletes a pipeline named MySecondPipeline from AWS CodePipeline. Use the list-pipelines command to view a list of pipelines associated with your AWS account.
Command:
```
aws codepipeline delete-pipeline --name MySecondPipeline
```
Output:
```
None.
```
+ For API details, see [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html) in *AWS CLI Command Reference*.
### `delete-webhook`
The following code example shows how to use `delete-webhook`.
**AWS CLI**
**To delete a webhook**
The following `delete-webhook` example deletes a webhook for a GitHub version 1 source action. You must use the `deregister-webhook-with-third-party` command to deregister the webhook before you delete it.
```
aws codepipeline delete-webhook \
--name my-webhook
```
This command produces no output.
For more information, see [Delete the webhook for your GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) in the *AWS CodePipeline User Guide*.
+ For API details, see [DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-webhook.html) in *AWS CLI Command Reference*.
### `deregister-webhook-with-third-party`
The following code example shows how to use `deregister-webhook-with-third-party`.
**AWS CLI**
**To deregister a webhook**
The following `deregister-webhook-with-third-party` example deletes a webhook for a GitHub version 1 source action. You must deregister the webhook before you delete it.
```
aws codepipeline deregister-webhook-with-third-party \
--webhook-name my-webhook
```
This command produces no output.
For more information, see [Delete the webhook for your GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete) in the *AWS CodePipeline User Guide*.
+ For API details, see [DeregisterWebhookWithThirdParty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/deregister-webhook-with-third-party.html) in *AWS CLI Command Reference*.
### `disable-stage-transition`
The following code example shows how to use `disable-stage-transition`.
**AWS CLI**
**To disable a transition to a stage in a pipeline**
This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
Command:
```
aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Output:
```
None.
```
+ For API details, see [DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html) in *AWS CLI Command Reference*.
### `enable-stage-transition`
The following code example shows how to use `enable-stage-transition`.
**AWS CLI**
**To enable a transition to a stage in a pipeline**
This example enables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.
Command:
```
aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound
```
Output:
```
None.
```
+ For API details, see [EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html) in *AWS CLI Command Reference*.
### `get-job-details`
The following code example shows how to use `get-job-details`.
**AWS CLI**
**To get details of a job**
This example returns details about a job whose ID is represented by f4f4ff82-2d11-EXAMPLE. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if required for the custom action. This command will also return any secret values defined for the action, if any are defined.
Command:
```
aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE
```
Output:
```
{
"jobDetails": {
"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "MyJenkinsExampleTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",
"action": {
"name": "MyJenkinsTest-Action"
},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "f4f4ff82-2d11-EXAMPLE"
}
}
```
+ For API details, see [GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html) in *AWS CLI Command Reference*.
### `get-pipeline-state`
The following code example shows how to use `get-pipeline-state`.
**AWS CLI**
**To get information about the state of a pipeline**
This example returns the most recent state of a pipeline named MyFirstPipeline.
Command:
```
aws codepipeline get-pipeline-state --name MyFirstPipeline
```
Output:
```
{
"created": 1446137312.204,
"pipelineName": "MyFirstPipeline",
"pipelineVersion": 1,
"stageStates": [
{
"actionStates": [
{
"actionName": "Source",
"entityUrl": "https://console.aws.amazon.com/s3/home?#",
"latestExecution": {
"lastStatusChange": 1446137358.328,
"status": "Succeeded"
}
}
],
"stageName": "Source"
},
{
"actionStates": [
{
"actionName": "CodePipelineDemoFleet",
"entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet",
"latestExecution": {
"externalExecutionId": "d-EXAMPLE",
"externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE",
"lastStatusChange": 1446137493.131,
"status": "Succeeded",
"summary": "Deployment Succeeded"
}
}
],
"inboundTransitionState": {
"enabled": true
},
"stageName": "Beta"
}
],
"updated": 1446137312.204
}
```
+ For API details, see [GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html) in *AWS CLI Command Reference*.
### `get-pipeline`
The following code example shows how to use `get-pipeline`.
**AWS CLI**
**To view the structure of a pipeline**
This example returns the structure of a pipeline named MyFirstPipeline.
Command:
```
aws codepipeline get-pipeline --name MyFirstPipeline
```
Output:
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MyFirstPipeline",
"version": 1
}
}
```
+ For API details, see [GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html) in *AWS CLI Command Reference*.
### `list-action-executions`
The following code example shows how to use `list-action-executions`.
**AWS CLI**
**To list action executions**
The following `list-action-executions` example views action execution details for a pipeline, such as action execution ID, input artifacts, output artifacts, execution result, and status.
```
aws codepipeline list-action-executions \
--pipeline-name myPipeline
```
Output:
```
{
"actionExecutionDetails": [
{
"pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3",
"actionExecutionId": "EXAMPLE4-2ee8-4853-bd6a-111111158148",
"pipelineVersion": 12,
"stageName": "Deploy",
"actionName": "Deploy",
"startTime": 1598572628.6,
"lastUpdateTime": 1598572661.255,
"status": "Succeeded",
"input": {
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {
"ApplicationName": "my-application",
"DeploymentGroupName": "my-deployment-group"
},
"resolvedConfiguration": {
"ApplicationName": "my-application",
"DeploymentGroupName": "my-deployment-group"
},
"region": "us-east-1",
"inputArtifacts": [
{
"name": "SourceArtifact",
"s3location": {
"bucket": "artifact-bucket",
"key": "myPipeline/SourceArti/key"
}
}
],
"namespace": "DeployVariables"
},
"output": {
"outputArtifacts": [],
"executionResult": {
"externalExecutionId": "d-EXAMPLEE5",
"externalExecutionSummary": "Deployment Succeeded",
"externalExecutionUrl": "https://myaddress.com"
},
"outputVariables": {}
}
},
{
"pipelineExecutionId": "EXAMPLE0-adfc-488e-bf4c-1111111720d3",
"actionExecutionId": "EXAMPLE5-abb4-4192-9031-11111113a7b0",
"pipelineVersion": 12,
"stageName": "Source",
"actionName": "Source",
"startTime": 1598572624.387,
"lastUpdateTime": 1598572628.16,
"status": "Succeeded",
"input": {
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"provider": "CodeCommit",
"version": "1"
},
"configuration": {
"BranchName": "production",
"PollForSourceChanges": "false",
"RepositoryName": "my-repo"
},
"resolvedConfiguration": {
"BranchName": "production",
"PollForSourceChanges": "false",
"RepositoryName": "my-repo"
},
"region": "us-east-1",
"inputArtifacts": [],
"namespace": "SourceVariables"
},
"output": {
"outputArtifacts": [
{
"name": "SourceArtifact",
"s3location": {
"bucket": "amzn-s3-demo-bucket",
"key": "myPipeline/SourceArti/key"
}
}
],
"executionResult": {
"externalExecutionId": "1111111ad99dcd35914c00b7fbea13995EXAMPLE",
"externalExecutionSummary": "Edited template.yml",
"externalExecutionUrl": "https://myaddress.com"
},
"outputVariables": {
"AuthorDate": "2020-05-08T17:45:43Z",
"BranchName": "production",
"CommitId": "EXAMPLEad99dcd35914c00b7fbea139951111111",
"CommitMessage": "Edited template.yml",
"CommitterDate": "2020-05-08T17:45:43Z",
"RepositoryName": "my-repo"
}
}
},
. . . .
```
For more information, see [View action executions (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-action-executions-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [ListActionExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-executions.html) in *AWS CLI Command Reference*.
### `list-action-types`
The following code example shows how to use `list-action-types`.
**AWS CLI**
**To view the action types available**
Used by itself, the list-action-types command returns the structure of all actions available to your AWS account. This example uses the --action-owner-filter option to return only custom actions.
Command:
```
aws codepipeline list-action-types --action-owner-filter Custom
```
Output:
```
{
"actionTypes": [
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "MyJenkinsExampleBuildProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Build",
"owner": "Custom",
"version": "1",
"provider": "MyJenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "MyJenkinsExampleTestProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Test",
"owner": "Custom",
"version": "1",
"provider": "MyJenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
}
}
]
}
```
+ For API details, see [ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html) in *AWS CLI Command Reference*.
### `list-pipeline-executions`
The following code example shows how to use `list-pipeline-executions`.
**AWS CLI**
**To view pipeline execution history**
The following `list-pipeline-executions` example shows the pipeline execution history for a pipeline in your AWS account.
```
aws codepipeline list-pipeline-executions \
--pipeline-name MyPipeline
```
Output:
```
{
"pipelineExecutionSummaries": [
{
"lastUpdateTime": 1496380678.648,
"pipelineExecutionId": "7cf7f7cb-3137-539g-j458-d7eu3EXAMPLE",
"startTime": 1496380258.243,
"status": "Succeeded"
},
{
"lastUpdateTime": 1496591045.634,
"pipelineExecutionId": "3137f7cb-8d494hj4-039j-d84l-d7eu3EXAMPLE",
"startTime": 1496590401.222,
"status": "Succeeded"
},
{
"lastUpdateTime": 1496946071.6456,
"pipelineExecutionId": "4992f7jf-7cf7-913k-k334-d7eu3EXAMPLE",
"startTime": 1496945471.5645,
"status": "Succeeded"
}
]
}
```
For more information, see [View execution history](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-executions-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [ListPipelineExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipeline-executions.html) in *AWS CLI Command Reference*.
### `list-pipelines`
The following code example shows how to use `list-pipelines`.
**AWS CLI**
**To view a list of pipelines**
This example lists all AWS CodePipeline pipelines associated with the user's AWS account.
Command:
```
aws codepipeline list-pipelines
```
Output:
```
{
"pipelines": [
{
"updated": 1439504274.641,
"version": 1,
"name": "MyFirstPipeline",
"created": 1439504274.641
},
{
"updated": 1436461837.992,
"version": 2,
"name": "MySecondPipeline",
"created": 1436460801.381
}
]
}
```
+ For API details, see [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list tags**
The following `list-tags-for-resource` example retrieves a list of all tags attached to the specified pipeline resource.
```
aws codepipeline list-tags-for-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline
```
Output:
```
{
"tags": {
"Project": "ProjectA",
"IscontainerBased": "true"
}
}
```
For more information, see [View tags for a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-list-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `list-webhooks`
The following code example shows how to use `list-webhooks`.
**AWS CLI**
**To list webhooks**
The following `list-webhooks` example retrieves a list of all tags attached to the specified pipeline resource.
```
aws codepipeline list-webhooks \
--endpoint-url "https://codepipeline.eu-central-1.amazonaws.com" \
--region "eu-central-1"
```
Output:
```
{
"webhooks": [
{
"url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111": {
"authenticationConfiguration": {
"SecretToken": "Secret"
},
"name": "my-webhook",
"authentication": "GITHUB_HMAC",
"targetPipeline": "my-Pipeline",
"targetAction": "Source",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
]
},
"arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook"
}
]
}
```
For more information, see [List webhooks in your account](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-view) in the *AWS CodePipeline User Guide*.
+ For API details, see [ListWebhooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-webhooks.html) in *AWS CLI Command Reference*.
### `poll-for-jobs`
The following code example shows how to use `poll-for-jobs`.
**AWS CLI**
**To view any available jobs**
This example returns information about any jobs for a job worker to act upon. This example uses a pre-defined JSON file (MyActionTypeInfo.json) to supply information about the action type for which the job worker processes jobs. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline. This command will also return any secret values defined for the action, if any are defined.
Command:
```
aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json
```
JSON file sample contents:
```
{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "MyJenkinsTestProject"
}
}
```
Output:
```
{
"jobs": [
{
"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "MyJenkinsExampleTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "MyJenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",
"action": {
"name": "MyJenkinsTest-Action"
},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "ef66c259-64f9-EXAMPLE",
"nonce": "3"
}
]
}
```
+ For API details, see [PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html) in *AWS CLI Command Reference*.
### `put-webhook`
The following code example shows how to use `put-webhook`.
**AWS CLI**
**To create a webhook**
The following `put-webhook` example creates a webhook for a GitHub version 1 source action. After you create the webhook, you must use the register-webhook-with-third-party command to register it.
```
aws codepipeline put-webhook \
--cli-input-json file://webhook_json.json \
--region "eu-central-1"
```
Contents of `webhook_json.json`:
```
{
"webhook": {
"name": "my-webhook",
"targetPipeline": "pipeline_name",
"targetAction": "source_action_name",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
],
"authentication": "GITHUB_HMAC",
"authenticationConfiguration": {
"SecretToken": "secret"
}
}
}
```
Output:
```
{
"webhook": {
"url": "https://webhooks.domain.com/trigger111111111EXAMPLE11111111111111111",
"definition": {
"authenticationConfiguration": {
"SecretToken": "secret"
},
"name": "my-webhook",
"authentication": "GITHUB_HMAC",
"targetPipeline": "pipeline_name",
"targetAction": "Source",
"filters": [
{
"jsonPath": "$.ref",
"matchEquals": "refs/heads/{Branch}"
}
]
},
"arn": "arn:aws:codepipeline:eu-central-1:123456789012:webhook:my-webhook"
},
"tags": [
{
"key": "Project",
"value": "ProjectA"
}
]
}
```
For more information, see [Create a webhook for a GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-create) in the *AWS CodePipeline User Guide*.
+ For API details, see [PutWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/put-webhook.html) in *AWS CLI Command Reference*.
### `retry-stage-execution`
The following code example shows how to use `retry-stage-execution`.
**AWS CLI**
**To retry a failed action**
The following `retry-stage-execution` example retries a stage that has a failed action.
```
aws codepipeline retry-stage-execution \
--pipeline-name MyPipeline \
--stage-name Deploy \
--pipeline-execution-id b59babff-5f34-EXAMPLE \
--retry-mode FAILED_ACTIONS
```
Output:
```
{
"pipelineExecutionId": "b59babff-5f34-EXAMPLE"
}
```
For more information, see [Retry failed actions (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-retry.html#actions-retry-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [RetryStageExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/retry-stage-execution.html) in *AWS CLI Command Reference*.
### `start-pipeline-execution`
The following code example shows how to use `start-pipeline-execution`.
**AWS CLI**
**To run the latest revision through a pipeline**
This example runs the latest revision present in the source stage of a pipeline through the pipeline named "MyFirstPipeline".
Command:
```
aws codepipeline start-pipeline-execution --name MyFirstPipeline
```
Output:
```
{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```
+ For API details, see [StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html) in *AWS CLI Command Reference*.
### `stop-pipeline-execution`
The following code example shows how to use `stop-pipeline-execution`.
**AWS CLI**
**To stop a pipeline execution**
The following `stop-pipeline-execution` example defaults to waiting until in-progress actions finish, and then stops the pipeline. You cannot choose to stop and wait if the execution is already in a Stopping state. You can choose to stop and abandon an execution that is already in a Stopping state.
```
aws codepipeline stop-pipeline-execution \
--pipeline-name MyFirstPipeline \
--pipeline-execution-id d-EXAMPLE \
--reason "Stopping pipeline after the build action is done"
```
This command returns no output.
For more information, see [Stop a pipeline execution (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-stop.html#pipelines-stop-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [StopPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/stop-pipeline-execution.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To tag a resource**
The following `tag-resource` example associates a set of provided tags with a pipeline. Use this command to add or edit tags.
```
aws codepipeline tag-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \
--tags key=Project,value=ProjectA key=IscontainerBased,value=true
```
This command produces no output.
For more information, see [Add tags to a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-add-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove AWS tags from a connections resource**
The following `untag-resource` example removes a tag from the specified resource.
```
aws codepipeline untag-resource \
--resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \
--tag-keys Project IscontainerBased
```
This command produces no output.
For more information, see [Remove tags from a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-delete-cli) in the *AWS CodePipeline User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/untag-resource.html) in *AWS CLI Command Reference*.
### `update-pipeline`
The following code example shows how to use `update-pipeline`.
**AWS CLI**
**To update the structure of a pipeline**
This example uses the update-pipeline command with the --cli-input-json argument. This example uses a pre-defined JSON file (MyFirstPipeline.json) to update the structure of a pipeline. AWS CodePipeline recognizes the pipeline name contained in the JSON file, and then applies any changes from modified fields in the pipeline structure to update the pipeline.
Use the following guidelines when creating the pre-defined JSON file:
If you are working with a pipeline structure retrieved using the get-pipeline command, you must remove the metadata section from the pipeline structure in the JSON file (the "metadata": \$1 \$1 lines and the "created," "pipelineARN," and "updated" fields within).The pipeline name cannot be changed.
Command:
```
aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json
```
Sample JSON file contents:
```
{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket2",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Beta",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MyFirstPipeline",
"version": 1
}
}
```
Output:
```
{
"pipeline": {
"artifactStore": {
"location": "codepipeline-us-east-1-11EXAMPLE11",
"type": "S3"
},
"name": "MyFirstPipeline",
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Source",
"owner": "AWS",
"provider": "S3",
"version": "1"
},
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket2",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"inputArtifacts": [],
"name": "Source",
"outputArtifacts": [
{
"name": "MyApp"
}
],
"runOrder": 1
}
],
"name": "Source"
},
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"outputArtifacts": [],
"runOrder": 1
}
],
"name": "Beta"
}
],
"version": 3
}
}
```
+ For API details, see [UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html) in *AWS CLI Command Reference*.
# AWS CodeStar Notifications examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS CodeStar Notifications.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-notification-rule`
The following code example shows how to use `create-notification-rule`.
**AWS CLI**
**To create a notification rule**
The following `create-notification-rule` example uses a JSON file named `rule.json` to create a notification rule named `MyNotificationRule` for a repository named `MyDemoRepo` in the specified AWS account. Notifications with the `FULL` detail type are sent to the specified target Amazon SNS topic when branches and tags are created.
```
aws codestar-notifications create-notification-rule \
--cli-input-json file://rule.json
```
Contents of `rule.json`:
```
{
"Name": "MyNotificationRule",
"EventTypeIds": [
"codecommit-repository-branches-and-tags-created"
],
"Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
"Targets": [
{
"TargetType": "SNS",
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
],
"Status": "ENABLED",
"DetailType": "FULL"
}
```
Output:
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
For more information, see [Create a Notification rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [CreateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/create-notification-rule.html) in *AWS CLI Command Reference*.
### `delete-notification-rule`
The following code example shows how to use `delete-notification-rule`.
**AWS CLI**
**To delete a notification rule**
The following `delete-notification-rule` example deletes the specified notification rule.
```
aws codestar-notifications delete-notification-rule \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE
```
Output:
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
For more information, see [Delete a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-delete.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [DeleteNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-notification-rule.html) in *AWS CLI Command Reference*.
### `delete-target`
The following code example shows how to use `delete-target`.
**AWS CLI**
**To delete a notification rule target**
The following `delete-target` example removes the specified target from all notification rules configured to use it as a target, and then deletes the target.
```
aws codestar-notifications delete-target \
--target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \
--force-unsubscribe-all
```
This command produces no output.
For more information, see [Delete a Notification Rule Target](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-delete.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [DeleteTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-target.html) in *AWS CLI Command Reference*.
### `describe-notification-rule`
The following code example shows how to use `describe-notification-rule`.
**AWS CLI**
**To retrieve details of a notification rule**
The following `describe-notification-rule` example retrieves the details of the specified notification rule.
```
aws codestar-notifications describe-notification-rule \
--arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE
```
Output:
```
{
"LastModifiedTimestamp": 1569199844.857,
"EventTypes": [
{
"ServiceName": "CodeCommit",
"EventTypeName": "Branches and tags: Created",
"ResourceType": "Repository",
"EventTypeId": "codecommit-repository-branches-and-tags-created"
}
],
"Status": "ENABLED",
"DetailType": "FULL",
"Resource": "arn:aws:codecommit:us-west-2:123456789012:MyDemoRepo",
"Arn": "arn:aws:codestar-notifications:us-west-w:123456789012:notificationrule/dc82df7a-EXAMPLE",
"Targets": [
{
"TargetStatus": "ACTIVE",
"TargetAddress": "arn:aws:sns:us-west-2:123456789012:MyNotificationTopic",
"TargetType": "SNS"
}
],
"Name": "MyNotificationRule",
"CreatedTimestamp": 1569199844.857,
"CreatedBy": "arn:aws:iam::123456789012:user/Mary_Major"
}
```
For more information, see [View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [DescribeNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/describe-notification-rule.html) in *AWS CLI Command Reference*.
### `list-event-types`
The following code example shows how to use `list-event-types`.
**AWS CLI**
**To get a list of event types for a notification rule**
The following `list-event-types` example retrieves a filtered list of all available notification event types for CodeDeploy applications. If instead you use no filter, the command returns all notification event types for all resource types.
```
aws codestar-notifications list-event-types \
--filters Name=SERVICE_NAME,Value=CodeDeploy
```
Output:
```
{
"EventTypes": [
{
"EventTypeId": "codedeploy-application-deployment-succeeded",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Succeeded",
"ResourceType": "Application"
},
{
"EventTypeId": "codedeploy-application-deployment-failed",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Failed",
"ResourceType": "Application"
},
{
"EventTypeId": "codedeploy-application-deployment-started",
"ServiceName": "CodeDeploy",
"EventTypeName": "Deployment: Started",
"ResourceType": "Application"
}
]
}
```
For more information, see [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [ListEventTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-event-types.html) in *AWS CLI Command Reference*.
### `list-notification-rules`
The following code example shows how to use `list-notification-rules`.
**AWS CLI**
**To retrieve a list of notification rules**
The following `list-notification-rules` example retrieves a list of all notification rules in the specified AWS Region.
```
aws codestar-notifications list-notification-rules --region us-east-1
```
Output:
```
{
"NotificationRules": [
{
"Id": "dc82df7a-EXAMPLE",
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
},
{
"Id": "8d1f0983-EXAMPLE",
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/8d1f0983-EXAMPLE"
}
]
}
```
For more information, see [View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [ListNotificationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-notification-rules.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To get a list of tags attached to a notification rule**
The following `list-tags-for-resource` example retrieves a list of all tags attached to the specified notification rule. In this example, the notification rule currently has no tags associated with it.
```
aws codestar-notifications list-tags-for-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE
```
Output:
```
{
"Tags": {}
}
```
For more information, see [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `list-targets`
The following code example shows how to use `list-targets`.
**AWS CLI**
**To retrieve a list of notification rule targets**
The following `list-targets` example retrieves a list of all notification rule targets in the specified AWS Region.
```
aws codestar-notifications list-targets \
--region us-east-1
```
Output:
```
{
"Targets": [
{
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationRules",
"TargetType": "SNS",
"TargetStatus": "ACTIVE"
},
{
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MySNSTopicForNotificationsAboutMyDemoRepo",
"TargetType": "SNS",
"TargetStatus": "ACTIVE"
}
]
}
```
For more information, see [View Notification Rule Targets](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-view.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [ListTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-targets.html) in *AWS CLI Command Reference*.
### `subscribe`
The following code example shows how to use `subscribe`.
**AWS CLI**
**To add a target to a notification rule**
The following `subscribe` example adds an Amazon SNS topic as a target for the specified notification rule.
```
aws codestar-notifications subscribe \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
--target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic
```
Output:
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
For more information, see [Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/subscribe.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To add a tag to a notification rule**
The following `tag-resource` example adds a tag with the key name of `Team` and the value of `Li_Juan` to the specified notification rule.
```
aws codestar-notifications tag-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
--tags Team=Li_Juan
```
Output:
```
{
"Tags": {
"Team": "Li_Juan"
}
}
```
For more information, see [Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/tag-resource.html) in *AWS CLI Command Reference*.
### `unsubscribe`
The following code example shows how to use `unsubscribe`.
**AWS CLI**
**To remove a target from a notification rule**
The following `unsubscribe` example removes an Amazon SNS topic as a target from the specified notification rule.
```
aws codestar-notifications unsubscribe \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE \
--target TargetType=SNS,TargetAddress=arn:aws:sns:us-east-1:123456789012:MyNotificationTopic
```
Output:
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
```
For more information, see [Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [Unsubscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/unsubscribe.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove a tag from a notification rule**
The following `untag-resource` example removes the tag with the key name `Team` from the specified notification rule.
```
aws codestar-notifications untag-resource \
--arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \
--tag-keys Team
```
This command produces no output.
For more information, see [Edit a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-edit.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/untag-resource.html) in *AWS CLI Command Reference*.
### `update-notification-rule`
The following code example shows how to use `update-notification-rule`.
**AWS CLI**
**To update a notification rule**
The following `update-notification-rule` example updates a notification rule named `MyNotificationRule` in the AWS account `123456789012` using a JSON file named `update.json`.
```
aws codestar-notifications update-notification-rule \
--cli-input-json file://update.json
```
Contents of `update.json`:
```
{
"Name": "MyUpdatedNotificationRule",
"EventTypeIds": [
"codecommit-repository-branches-and-tags-created"
],
"Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
"Targets": [
{
"TargetType": "SNS",
"TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
}
],
"Status": "ENABLED",
"DetailType": "FULL"
}
```
Output:
```
{
"Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}
```
For more information, see [Edit a notification rule](https://docs.aws.amazon.com/dtconsole/latest/userguide/notification-rule-edit.html) in the *AWS Developer Tools Console User Guide*.
+ For API details, see [UpdateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/update-notification-rule.html) in *AWS CLI Command Reference*.
# CodeConnections examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with CodeConnections.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-connection`
The following code example shows how to use `create-connection`.
**AWS CLI**
**To create a connection**
The following `create-connection` example shows how to create a connection to a third-party repository. This example creates a connection where the third-party provider is Bitbucket.
A connection created through the AWS CLI or AWS CloudFormation is in Pending status by default. After you create a connection with the CLI or AWS CloudFormation, use the console to edit the connection to make its status Available.
```
aws codestar-connections create-connection \
--provider-type Bitbucket \
--connection-name MyConnection
```
Output:
```
{
"ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}
```
For more information, see [Create a connection](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html) in the *Developer Tools console User Guide*.
+ For API details, see [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-connection.html) in *AWS CLI Command Reference*.
### `create-host`
The following code example shows how to use `create-host`.
**AWS CLI**
**To create a host**
The following `create-host` example shows how to create a host to represent the endpoint for the infrastructure where your third-party provider is installed. This example creates a host where the third-party installed provider is GitHub Enterprise Server.
A host created through the AWS CLI is in Pending status by default. After you create a host with the CLI, use the console or the CLI to set up the host to make its status Available.
```
aws codestar-connections create-host \
--name MyHost \
--provider-type GitHubEnterpriseServer \
--provider-endpoint "https://my-instance.dev"
```
Output:
```
{
"HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605"
}
```
For more information, see [Create a host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-create.html) in the *Developer Tools console User Guide*.
+ For API details, see [CreateHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-host.html) in *AWS CLI Command Reference*.
### `delete-connection`
The following code example shows how to use `delete-connection`.
**AWS CLI**
**To delete a connection**
The following `delete-connection` example shows how to delete a connection.
```
aws codestar-connections delete-connection \
--connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
```
This command produces no output.
For more information, see [Delete a connection (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-delete.html#connections-delete-cli) in the *Developer Tools console User Guide*.
+ For API details, see [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-connection.html) in *AWS CLI Command Reference*.
### `delete-host`
The following code example shows how to use `delete-host`.
**AWS CLI**
**To delete a host**
The following `delete-host` example shows how to delete a host. Before you can delete a host, you must delete all connections associated with the host.
```
aws codestar-connections delete-host \
--host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605"
```
This command produces no output.
For more information, see [Delete a host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-delete.html#connections-host-delete-cli) in the *Developer Tools console User Guide*.
+ For API details, see [DeleteHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-host.html) in *AWS CLI Command Reference*.
### `get-connection`
The following code example shows how to use `get-connection`.
**AWS CLI**
**To get information about a connection**
The following `get-connection` example shows details about a connection.
```
aws codestar-connections get-connection \
--connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
```
Output:
```
{
"Connection": {
"ConnectionName": "MyConnection",
"ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
"ProviderType": "Bitbucket",
"OwnerAccountId": "123456789012",
"ConnectionStatus": "AVAILABLE"
}
}
```
For more information, see [View connection details](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-view-details.html) in the *Developer Tools console User Guide*.
+ For API details, see [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-connection.html) in *AWS CLI Command Reference*.
### `get-host`
The following code example shows how to use `get-host`.
**AWS CLI**
**To get information about a host**
The following `get-host` example shows details about a host:
```
aws codestar-connections get-host \
--host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605
```
Output:
```
{
"Name": "MyHost",
"Status": "AVAILABLE",
"ProviderType": "GitHubEnterpriseServer",
"ProviderEndpoint": "https://test-instance-1.dev/"
}
```
For more information, see [View host details (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-view.html#connections-host-view-cli) in the *Developer Tools console User Guide*.
+ For API details, see [GetHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-host.html) in *AWS CLI Command Reference*.
### `list-connections`
The following code example shows how to use `list-connections`.
**AWS CLI**
**To list connections**
The following `list-connections` example retrieves a list of all connections in your account for the Bitbucket provider type.:
```
aws codestar-connections list-connections \
--provider-type Bitbucket \
--max-results 5 \
--next-token: next-token
```
Output:
```
{
"Connections": [
{
"ConnectionName": "my-connection",
"ProviderType": "Bitbucket",
"Status": "PENDING",
"ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
"OwnerAccountId": "123456789012"
},
{
"ConnectionName": "my-other-connection",
"ProviderType": "Bitbucket",
"Status": "AVAILABLE",
"ARN": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f",
"OwnerAccountId": "123456789012"
},
],
"NextToken": "next-token"
}
```
For more information, see [List connections (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-list.html#connections-list-cli) in the *Developer Tools console User Guide*.
+ For API details, see [ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-connections.html) in *AWS CLI Command Reference*.
### `list-hosts`
The following code example shows how to use `list-hosts`.
**AWS CLI**
**To list hosts**
The following `list-hosts` example retrieves a list of all hosts in your account.
```
aws codestar-connections list-hosts
```
Output:
```
{
"Hosts": [
{
"Name": "My-Host",
"HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605",
"ProviderType": "GitHubEnterpriseServer",
"ProviderEndpoint": "https://my-instance.test.dev",
"Status": "AVAILABLE"
}
]
}
```
For more information, see [List hosts (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-list.html) in the *Developer Tools console User Guide*.
+ For API details, see [ListHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-hosts.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list tags**
The following `list-tags-for-resource` example retrieves a list of all tags attached to the specified connections resource.
```
aws codestar-connections list-tags-for-resource \
--resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f
```
Output:
```
{
"Tags": [
{
"Key": "Project",
"Value": "ProjectA"
},
{
"Key": "ReadOnly",
"Value": "true"
}
]
}
```
For more information, see [View tags for a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-view) in the *Developer Tools console User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To tag a resource**
The following `tag-resource` example associates a set of provided tags with a connection. Use this command to add or edit tags.
```
aws codestar-connections tag-resource \
--resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
--tags Key=Project,Value=ProjectA Key=IscontainerBased,Value=true
```
This command produces no output.
For more information, see [Add tags to a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-add) in the *Developer Tools console User Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove AWS tags from a connections resource**
The following `untag-resource` removes a tag from the specified resource.
```
aws codestar-connections untag-resource \
--resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f \
--tag-keys Project ReadOnly
```
Output:
```
{
"Tags": []
}
```
For more information, see [Remove tags from a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-delete) in the *Developer Tools console User Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/untag-resource.html) in *AWS CLI Command Reference*.
# Amazon Cognito Identity examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Cognito Identity.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-identity-pool`
The following code example shows how to use `create-identity-pool`.
**AWS CLI**
**To create an identity pool with Cognito identity pool provider**
This example creates an identity pool named MyIdentityPool. It has a Cognito identity pool provider. Unauthenticated identities are not allowed.
Command:
```
aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [CreateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/create-identity-pool.html) in *AWS CLI Command Reference*.
### `delete-identities`
The following code example shows how to use `delete-identities`.
**AWS CLI**
**To delete identity pool**
This example deletes an identity pool.
Command:
```
aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111"
```
Output:
```
{
"UnprocessedIdentityIds": []
}
```
+ For API details, see [DeleteIdentities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identities.html) in *AWS CLI Command Reference*.
### `delete-identity-pool`
The following code example shows how to use `delete-identity-pool`.
**AWS CLI**
**To delete identity pool**
The following `delete-identity-pool` example deletes the specified identity pool.
Command:
```
aws cognito-identity delete-identity-pool \
--identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
This command produces no output.
+ For API details, see [DeleteIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identity-pool.html) in *AWS CLI Command Reference*.
### `describe-identity-pool`
The following code example shows how to use `describe-identity-pool`.
**AWS CLI**
**To describe an identity pool**
This example describes an identity pool.
Command:
```
aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [DescribeIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/describe-identity-pool.html) in *AWS CLI Command Reference*.
### `get-identity-pool-roles`
The following code example shows how to use `get-identity-pool-roles`.
**AWS CLI**
**To get identity pool roles**
This example gets identity pool roles.
Command:
```
aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"Roles": {
"authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role",
"unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role"
}
}
```
+ For API details, see [GetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/get-identity-pool-roles.html) in *AWS CLI Command Reference*.
### `list-identity-pools`
The following code example shows how to use `list-identity-pools`.
**AWS CLI**
**To list identity pools**
This example lists identity pools. There s a maximum of 20 identities listed.
Command:
```
aws cognito-identity list-identity-pools --max-results 20
```
Output:
```
{
"IdentityPools": [
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool"
},
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "AnotherIdentityPool"
},
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "IdentityPoolRegionA"
}
]
}
```
+ For API details, see [ListIdentityPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/list-identity-pools.html) in *AWS CLI Command Reference*.
### `set-identity-pool-roles`
The following code example shows how to use `set-identity-pool-roles`.
**AWS CLI**
**To set identity pool roles**
The following `set-identity-pool-roles` example sets an identity pool role.
```
aws cognito-identity set-identity-pool-roles \
--identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \
--roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role"
```
+ For API details, see [SetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/set-identity-pool-roles.html) in *AWS CLI Command Reference*.
### `update-identity-pool`
The following code example shows how to use `update-identity-pool`.
**AWS CLI**
**To update an identity pool**
This example updates an identity pool. It sets the name to MyIdentityPool. It adds Cognito as an identity provider. It disallows unauthenticated identities.
Command:
```
aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false
```
Output:
```
{
"IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
"IdentityPoolName": "MyIdentityPool",
"AllowUnauthenticatedIdentities": false,
"CognitoIdentityProviders": [
{
"ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
"ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
"ServerSideTokenCheck": false
}
]
}
```
+ For API details, see [UpdateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/update-identity-pool.html) in *AWS CLI Command Reference*.
# Amazon Cognito Identity Provider examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Cognito Identity Provider.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `add-custom-attributes`
The following code example shows how to use `add-custom-attributes`.
**AWS CLI**
**To add a custom attribute**
This example adds a custom attribute CustomAttr1 to a user pool. It is a String type, and requires a minimum of 1 character and a maximum of 15. It is not required.
Command:
```
aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"
```
+ For API details, see [AddCustomAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/add-custom-attributes.html) in *AWS CLI Command Reference*.
### `admin-add-user-to-group`
The following code example shows how to use `admin-add-user-to-group`.
**AWS CLI**
**To add a user to a group**
This example adds user Jane to group MyGroup.
Command:
```
aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup
```
+ For API details, see [AdminAddUserToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-add-user-to-group.html) in *AWS CLI Command Reference*.
### `admin-confirm-sign-up`
The following code example shows how to use `admin-confirm-sign-up`.
**AWS CLI**
**To confirm user registration**
This example confirms user jane@example.com.
Command:
```
aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
```
+ For API details, see [AdminConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-confirm-sign-up.html) in *AWS CLI Command Reference*.
### `admin-create-user`
The following code example shows how to use `admin-create-user`.
**AWS CLI**
**To create a user**
The following `admin-create-user` example creates a user with the specified settings email address and phone number.
```
aws cognito-idp admin-create-user \
--user-pool-id us-west-2_aaaaaaaaa \
--username diego \
--user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \
--message-action SUPPRESS
```
Output:
```
{
"User": {
"Username": "diego",
"Attributes": [
{
"Name": "sub",
"Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2"
},
{
"Name": "phone_number",
"Value": "+15555551212"
},
{
"Name": "email",
"Value": "diego@example.com"
}
],
"UserCreateDate": 1548099495.428,
"UserLastModifiedDate": 1548099495.428,
"Enabled": true,
"UserStatus": "FORCE_CHANGE_PASSWORD"
}
}
```
+ For API details, see [AdminCreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-create-user.html) in *AWS CLI Command Reference*.
### `admin-delete-user-attributes`
The following code example shows how to use `admin-delete-user-attributes`.
**AWS CLI**
**To delete a user attribute**
This example deletes a custom attribute CustomAttr1 for user diego@example.com.
Command:
```
aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1"
```
+ For API details, see [AdminDeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user-attributes.html) in *AWS CLI Command Reference*.
### `admin-delete-user`
The following code example shows how to use `admin-delete-user`.
**AWS CLI**
**To delete a user**
This example deletes a user.
Command:
```
aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
```
+ For API details, see [AdminDeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user.html) in *AWS CLI Command Reference*.
### `admin-disable-provider-for-user`
The following code example shows how to use `admin-disable-provider-for-user`.
**AWS CLI**
**To unlink a federated user from a local user profile**
The following `admin-disable-provider-for-user` example disconnects a Google user from their linked local profile.
```
aws cognito-idp admin-disable-provider-for-user \
--user-pool-id us-west-2_EXAMPLE \
--user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google
```
For more information, see [Linking federated users to an existing user profile](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminDisableProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-provider-for-user.html) in *AWS CLI Command Reference*.
### `admin-disable-user`
The following code example shows how to use `admin-disable-user`.
**AWS CLI**
**To prevent sign-in by a user**
The following `admin-disable-user` example prevents sign-in by the user `diego@example.com`.
```
aws cognito-idp admin-disable-user \
--user-pool-id us-west-2_EXAMPLE \
--username diego@example.com
```
For more information, see [Managing users](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminDisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-user.html) in *AWS CLI Command Reference*.
### `admin-enable-user`
The following code example shows how to use `admin-enable-user`.
**AWS CLI**
**To enable sign-in by a user**
The following `admin-enable-user` example enables sign-in by the user diego@example.com.
```
aws cognito-idp admin-enable-user \
--user-pool-id us-west-2_EXAMPLE \
--username diego@example.com
```
For more information, see [Managing users](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminEnableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-enable-user.html) in *AWS CLI Command Reference*.
### `admin-forget-device`
The following code example shows how to use `admin-forget-device`.
**AWS CLI**
**To forget a device**
This example forgets device for username jane@example.com
Command:
```
aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678
```
+ For API details, see [AdminForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-forget-device.html) in *AWS CLI Command Reference*.
### `admin-get-device`
The following code example shows how to use `admin-get-device`.
**AWS CLI**
**To get a device**
The following `admin-get-device` example displays one device for the user `diego`.
```
aws cognito-idp admin-get-device \
--user-pool-id us-west-2_EXAMPLE \
--username diego \
--device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"Device": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "device_name",
"Value": "MyDevice"
},
{
"Name": "dev:device_arn",
"Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"Name": "dev:device_owner",
"Value": "diego.us-west-2_EXAMPLE"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.1"
},
{
"Name": "dev:device_remembered_status",
"Value": "remembered"
},
{
"Name": "dev:device_sdk",
"Value": "aws-sdk"
}
],
"DeviceCreateDate": 1715100742.022,
"DeviceLastModifiedDate": 1723233651.167,
"DeviceLastAuthenticatedDate": 1715100742.0
}
}
```
For more information, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminGetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-device.html) in *AWS CLI Command Reference*.
### `admin-get-user`
The following code example shows how to use `admin-get-user`.
**AWS CLI**
**To get a user**
This example gets information about username jane@example.com.
Command:
```
aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
```
Output:
```
{
"Username": "4320de44-2322-4620-999b-5e2e1c8df013",
"Enabled": true,
"UserStatus": "FORCE_CHANGE_PASSWORD",
"UserCreateDate": 1548108509.537,
"UserAttributes": [
{
"Name": "sub",
"Value": "4320de44-2322-4620-999b-5e2e1c8df013"
},
{
"Name": "email_verified",
"Value": "true"
},
{
"Name": "phone_number_verified",
"Value": "true"
},
{
"Name": "phone_number",
"Value": "+01115551212"
},
{
"Name": "email",
"Value": "jane@example.com"
}
],
"UserLastModifiedDate": 1548108509.537
}
```
+ For API details, see [AdminGetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-user.html) in *AWS CLI Command Reference*.
### `admin-initiate-auth`
The following code example shows how to use `admin-initiate-auth`.
**AWS CLI**
**To sign in a user as an admin**
The following `admin-initiate-auth` example signs in the user diego@example.com. This example also includes metadata for threat protection and ClientMetadata for Lambda triggers. The user is configured for TOTP MFA and receives a challenge to provide a code from their authenticator app before they can complete authentication.
```
aws cognito-idp admin-initiate-auth \
--user-pool-id us-west-2_EXAMPLE \
--client-id 1example23456789 \
--auth-flow ADMIN_USER_PASSWORD_AUTH \
--auth-parameters USERNAME=diego@example.com,PASSWORD="My@Example$Password3!",SECRET_HASH=ExampleEncodedClientIdSecretAndUsername= \
--context-data="{\"EncodedData\":\"abc123example\",\"HttpHeaders\":[{\"headerName\":\"UserAgent\",\"headerValue\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"}],\"IpAddress\":\"192.0.2.1\",\"ServerName\":\"example.com\",\"ServerPath\":\"/login\"}" \
--client-metadata="{\"MyExampleKey\": \"MyExampleValue\"}"
```
Output:
```
{
"ChallengeName": "SOFTWARE_TOKEN_MFA",
"Session": "AYABeExample...",
"ChallengeParameters": {
"FRIENDLY_DEVICE_NAME": "MyAuthenticatorApp",
"USER_ID_FOR_SRP": "diego@example.com"
}
}
```
For more information, see [Admin authentication flow](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminInitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-initiate-auth.html) in *AWS CLI Command Reference*.
### `admin-link-provider-for-user`
The following code example shows how to use `admin-link-provider-for-user`.
**AWS CLI**
**To link a local user to a federated user**
The following `admin-link-provider-for-user` example links the local user diego to a user who will do federated sign-in with Google.
```
aws cognito-idp admin-link-provider-for-user \
--user-pool-id us-west-2_EXAMPLE \
--destination-user ProviderName=Cognito,ProviderAttributeValue=diego \
--source-user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google
```
For more information, see [Linking federated users to an existing user profile](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminLinkProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-link-provider-for-user.html) in *AWS CLI Command Reference*.
### `admin-list-devices`
The following code example shows how to use `admin-list-devices`.
**AWS CLI**
**To list devices for a user**
The following `admin-list-devices` example lists devices for the user diego.
```
aws cognito-idp admin-list-devices \
--user-pool-id us-west-2_EXAMPLE \
--username diego \
--limit 1
```
Output:
```
{
"Devices": [
{
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "device_name",
"Value": "MyDevice"
},
{
"Name": "dev:device_arn",
"Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"Name": "dev:device_owner",
"Value": "diego.us-west-2_EXAMPLE"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.1"
},
{
"Name": "dev:device_remembered_status",
"Value": "remembered"
},
{
"Name": "dev:device_sdk",
"Value": "aws-sdk"
}
],
"DeviceCreateDate": 1715100742.022,
"DeviceLastModifiedDate": 1723233651.167,
"DeviceLastAuthenticatedDate": 1715100742.0
}
]
}
```
For more information, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-devices.html) in *AWS CLI Command Reference*.
### `admin-list-groups-for-user`
The following code example shows how to use `admin-list-groups-for-user`.
**AWS CLI**
**To list groups for a user**
This example lists groups for username jane@example.com.
Command:
```
aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
```
Output:
```
{
"Groups": [
{
"Description": "Sample group",
"Precedence": 1,
"LastModifiedDate": 1548097827.125,
"RoleArn": "arn:aws:iam::111111111111:role/SampleRole",
"GroupName": "SampleGroup",
"UserPoolId": "us-west-2_aaaaaaaaa",
"CreationDate": 1548097827.125
}
]
}
```
+ For API details, see [AdminListGroupsForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-groups-for-user.html) in *AWS CLI Command Reference*.
### `admin-list-user-auth-events`
The following code example shows how to use `admin-list-user-auth-events`.
**AWS CLI**
**To list authorization events for a user**
The following `admin-list-user-auth-events` example lists the most recent user activity log event for the user diego.
```
aws cognito-idp admin-list-user-auth-events \
--user-pool-id us-west-2_ywDJHlIfU \
--username brcotter+050123 \
--max-results 1
```
Output:
```
{
"AuthEvents": [
{
"EventId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"EventType": "SignIn",
"CreationDate": 1726694203.495,
"EventResponse": "InProgress",
"EventRisk": {
"RiskDecision": "AccountTakeover",
"RiskLevel": "Medium",
"CompromisedCredentialsDetected": false
},
"ChallengeResponses": [
{
"ChallengeName": "Password",
"ChallengeResponse": "Success"
}
],
"EventContextData": {
"IpAddress": "192.0.2.1",
"City": "Seattle",
"Country": "United States"
}
}
],
"NextToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222#2024-09-18T21:16:43.495Z"
}
```
For more information, see [Viewing and exporting user event history](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-event-user-history) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminListUserAuthEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-user-auth-events.html) in *AWS CLI Command Reference*.
### `admin-remove-user-from-group`
The following code example shows how to use `admin-remove-user-from-group`.
**AWS CLI**
**To remove a user from a group**
This example removes jane@example.com from SampleGroup.
Command:
```
aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup
```
+ For API details, see [AdminRemoveUserFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-remove-user-from-group.html) in *AWS CLI Command Reference*.
### `admin-reset-user-password`
The following code example shows how to use `admin-reset-user-password`.
**AWS CLI**
**To reset a user password**
This example resets the password for diego@example.com.
Command:
```
aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
```
+ For API details, see [AdminResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-reset-user-password.html) in *AWS CLI Command Reference*.
### `admin-respond-to-auth-challenge`
The following code example shows how to use `admin-respond-to-auth-challenge`.
**AWS CLI**
**To respond to an authentication challenge**
There are many ways to respond to different authentication challenges, depending on your authentication flow, user pool configuration, and user settings. The following `admin-respond-to-auth-challenge` example provides a TOTP MFA code for diego@example.com and completes sign-in. This user pool has device remembering turned on, so the authentication result also returns a new device key.
```
aws cognito-idp admin-respond-to-auth-challenge \
--user-pool-id us-west-2_EXAMPLE \
--client-id 1example23456789 \
--challenge-name SOFTWARE_TOKEN_MFA \
--challenge-responses USERNAME=diego@example.com,SOFTWARE_TOKEN_MFA_CODE=000000 \
--session AYABeExample...
```
Output:
```
{
"ChallengeParameters": {},
"AuthenticationResult": {
"AccessToken": "eyJra456defEXAMPLE",
"ExpiresIn": 3600,
"TokenType": "Bearer",
"RefreshToken": "eyJra123abcEXAMPLE",
"IdToken": "eyJra789ghiEXAMPLE",
"NewDeviceMetadata": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceGroupKey": "-ExAmPlE1"
}
}
}
```
For more information, see [Admin authentication flow](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminRespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html) in *AWS CLI Command Reference*.
### `admin-set-user-mfa-preference`
The following code example shows how to use `admin-set-user-mfa-preference`.
**AWS CLI**
**To set the user MFA preference**
This example sets the SMS MFA preference for username diego@example.com.
Command:
```
aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false
```
+ For API details, see [AdminSetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-mfa-preference.html) in *AWS CLI Command Reference*.
### `admin-set-user-password`
The following code example shows how to use `admin-set-user-password`.
**AWS CLI**
**To set a user password as an admin**
The following `admin-set-user-password` example permanently sets the password for diego@example.com.
```
aws cognito-idp admin-set-user-password \
--user-pool-id us-west-2_EXAMPLE \
--username diego@example.com \
--password MyExamplePassword1! \
--permanent
```
This command produces no output.
For more information, see [Passwords, password recovery, and password policies](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminSetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-password.html) in *AWS CLI Command Reference*.
### `admin-set-user-settings`
The following code example shows how to use `admin-set-user-settings`.
**AWS CLI**
**To set user settings**
This example sets the MFA delivery preference for username diego@example.com to EMAIL.
Command:
```
aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL
```
+ For API details, see [AdminSetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-settings.html) in *AWS CLI Command Reference*.
### `admin-update-auth-event-feedback`
The following code example shows how to use `admin-update-auth-event-feedback`.
**AWS CLI**
**To provide feedback for an authorization event**
This example sets the feedback value for an authorization event identified by event-id to Valid.
Command:
```
aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid
```
+ For API details, see [AdminUpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-auth-event-feedback.html) in *AWS CLI Command Reference*.
### `admin-update-device-status`
The following code example shows how to use `admin-update-device-status`.
**AWS CLI**
**To update device status**
This example sets the device remembered status for the device identified by device-key to not\$1remembered.
Command:
```
aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered
```
+ For API details, see [AdminUpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-device-status.html) in *AWS CLI Command Reference*.
### `admin-update-user-attributes`
The following code example shows how to use `admin-update-user-attributes`.
**AWS CLI**
**To update user attributes**
This example updates a custom user attribute CustomAttr1 for user diego@example.com.
Command:
```
aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple"
```
+ For API details, see [AdminUpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-user-attributes.html) in *AWS CLI Command Reference*.
### `admin-user-global-sign-out`
The following code example shows how to use `admin-user-global-sign-out`.
**AWS CLI**
**To sign out a user as an admin**
The following `admin-user-global-sign-out` example signs out the user diego@example.com.
```
aws cognito-idp admin-user-global-sign-out \
--user-pool-id us-west-2_EXAMPLE \
--username diego@example.com
```
For more information, see [Authentication with a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AdminUserGlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-user-global-sign-out.html) in *AWS CLI Command Reference*.
### `associate-software-token`
The following code example shows how to use `associate-software-token`.
**AWS CLI**
**To generate a secret key for an MFA authenticator app**
The following `associate-software-token` example generates a TOTP private key for a user who has signed in and received an access token. The resulting private key can be manually entered into an authenticator app, or applications can render it as a QR code that the user can scan.
```
aws cognito-idp associate-software-token \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"SecretCode": "QWERTYUIOP123456EXAMPLE"
}
```
For more information, see [TOTP software token MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [AssociateSoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/associate-software-token.html) in *AWS CLI Command Reference*.
### `change-password`
The following code example shows how to use `change-password`.
**AWS CLI**
**To change a password**
This example changes a password.
Command:
```
aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN
```
+ For API details, see [ChangePassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/change-password.html) in *AWS CLI Command Reference*.
### `confirm-device`
The following code example shows how to use `confirm-device`.
**AWS CLI**
**To confirm a user device**
The following `confirm-device` example adds a new remembered device for the current user.
```
aws cognito-idp confirm-device \
--access-token eyJra456defEXAMPLE \
--device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--device-secret-verifier-config PasswordVerifier=TXlWZXJpZmllclN0cmluZw,Salt=TXlTUlBTYWx0
```
Output:
```
{
"UserConfirmationNecessary": false
}
```
For more information, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ConfirmDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-device.html) in *AWS CLI Command Reference*.
### `confirm-forgot-password`
The following code example shows how to use `confirm-forgot-password`.
**AWS CLI**
**To confirm a forgotten password**
This example confirms a forgotten password for username diego@example.com.
Command:
```
aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE
```
+ For API details, see [ConfirmForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-forgot-password.html) in *AWS CLI Command Reference*.
### `confirm-sign-up`
The following code example shows how to use `confirm-sign-up`.
**AWS CLI**
**To confirm sign-up**
This example confirms sign-up for username diego@example.com.
Command:
```
aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE
```
+ For API details, see [ConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-sign-up.html) in *AWS CLI Command Reference*.
### `create-group`
The following code example shows how to use `create-group`.
**AWS CLI**
**To create a group**
This example creates a group with a description.
Command:
```
aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group."
```
Output:
```
{
"Group": {
"GroupName": "MyNewGroup",
"UserPoolId": "us-west-2_aaaaaaaaa",
"Description": "New group.",
"LastModifiedDate": 1548270073.795,
"CreationDate": 1548270073.795
}
}
```
**To create a group with a role and precedence**
This example creates a group with a description. It also includes a role and precedence.
Command:
```
aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2
```
Output:
```
{
"Group": {
"GroupName": "MyNewGroupWithRole",
"UserPoolId": "us-west-2_aaaaaaaaa",
"Description": "New group with a role.",
"RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole",
"Precedence": 2,
"LastModifiedDate": 1548270211.761,
"CreationDate": 1548270211.761
}
}
```
+ For API details, see [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-group.html) in *AWS CLI Command Reference*.
### `create-identity-provider`
The following code example shows how to use `create-identity-provider`.
**AWS CLI**
**Example 1: To create a user pool SAML identity provider (IdP) with a metadata URL**
The following `create-identity-provider` example creates a new SAML IdP with metadata from a public URL, attribute mapping, and two identifiers.
```
aws cognito-idp create-identity-provider \
--user-pool-id us-west-2_EXAMPLE \
--provider-name MySAML \
--provider-type SAML \
--provider-details IDPInit=true,IDPSignout=true,EncryptedResponses=true,MetadataURL=https://auth.example.com/sso/saml/metadata,RequestSigningAlgorithm=rsa-sha256 \
--attribute-mapping email=emailaddress,phone_number=phone,custom:111=department \
--idp-identifiers CorpSAML WestSAML
```
Output:
```
{
"IdentityProvider": {
"UserPoolId": "us-west-2_EXAMPLE",
"ProviderName": "MySAML",
"ProviderType": "SAML",
"ProviderDetails": {
"ActiveEncryptionCertificate": "MIICvTCCAaEXAMPLE",
"EncryptedResponses": "true",
"IDPInit": "true",
"IDPSignout": "true",
"MetadataURL": "https://auth.example.com/sso/saml/metadata",
"RequestSigningAlgorithm": "rsa-sha256",
"SLORedirectBindingURI": "https://auth.example.com/slo/saml",
"SSORedirectBindingURI": "https://auth.example.com/sso/saml"
},
"AttributeMapping": {
"custom:111": "department",
"emailaddress": "email",
"phone": "phone_number"
},
"IdpIdentifiers": [
"CorpSAML",
"WestSAML"
],
"LastModifiedDate": 1726853833.977,
"CreationDate": 1726853833.977
}
}
```
For more information, see [Adding user pool sign-in through a third party](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) in the *Amazon Cognito Developer Guide*.
**Example 2: To create a user pool SAML identity provider (IdP) with a metadata file**
The following `create-identity-provider` example creates a new SAML IdP with metadata from a file, attribute mapping, and two identifiers. File syntax can differ between operating systems in the `--provider-details` parameter. It's easiest to create a JSON input file for this operation.:
```
aws cognito-idp create-identity-provider \
--cli-input-json file://.\SAML-identity-provider.json
```
Contents of `SAML-identity-provider.json`:
```
{
"AttributeMapping": {
"email" : "idp_email",
"email_verified" : "idp_email_verified"
},
"IdpIdentifiers": [ "platform" ],
"ProviderDetails": {
"MetadataFile": "[IDP_CERTIFICATE_DATA]urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedurn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"IDPSignout" : "true",
"RequestSigningAlgorithm" : "rsa-sha256",
"EncryptedResponses" : "true",
"IDPInit" : "true"
},
"ProviderName": "MySAML2",
"ProviderType": "SAML",
"UserPoolId": "us-west-2_EXAMPLE"
}
```
Output:
```
{
"IdentityProvider": {
"UserPoolId": "us-west-2_EXAMPLE",
"ProviderName": "MySAML2",
"ProviderType": "SAML",
"ProviderDetails": {
"ActiveEncryptionCertificate": "[USER_POOL_ENCRYPTION_CERTIFICATE_DATA]",
"EncryptedResponses": "true",
"IDPInit": "true",
"IDPSignout": "true",
"MetadataFile": "[IDP_CERTIFICATE_DATA]urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedurn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"RequestSigningAlgorithm": "rsa-sha256",
"SLORedirectBindingURI": "https://www.example.com/slo/saml",
"SSORedirectBindingURI": "https://www.example.com/sso/saml"
},
"AttributeMapping": {
"email": "idp_email",
"email_verified": "idp_email_verified"
},
"IdpIdentifiers": [
"platform"
],
"LastModifiedDate": 1726855290.731,
"CreationDate": 1726855290.731
}
}
```
For more information, see [Adding user pool sign-in through a third party](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [CreateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-identity-provider.html) in *AWS CLI Command Reference*.
### `create-resource-server`
The following code example shows how to use `create-resource-server`.
**AWS CLI**
**To create a user pool client**
The following `create-resource-server` example creates a new resource server with custom scopes.
```
aws cognito-idp create-resource-server \
--user-pool-id us-west-2_EXAMPLE \
--identifier solar-system-data \
--name "Solar system object tracker" \
--scopes ScopeName=sunproximity.read,ScopeDescription="Distance in AU from Sol" ScopeName=asteroids.add,ScopeDescription="Enter a new asteroid"
```
Output:
```
{
"ResourceServer": {
"UserPoolId": "us-west-2_EXAMPLE",
"Identifier": "solar-system-data",
"Name": "Solar system object tracker",
"Scopes": [
{
"ScopeName": "sunproximity.read",
"ScopeDescription": "Distance in AU from Sol"
},
{
"ScopeName": "asteroids.add",
"ScopeDescription": "Enter a new asteroid"
}
]
}
}
```
For more information, see [Scopes, M2M, and APIs with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [CreateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-resource-server.html) in *AWS CLI Command Reference*.
### `create-user-import-job`
The following code example shows how to use `create-user-import-job`.
**AWS CLI**
**To create a user import job**
This example creates a user import job named MyImportJob.
For more information about importing users, see Importing Users into User Pools From a CSV File.
Command:
```
aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole
```
Output:
```
{
"UserImportJob": {
"JobName": "MyImportJob",
"JobId": "import-qQ0DCt2fRh",
"UserPoolId": "us-west-2_aaaaaaaaa",
"PreSignedUrl": "PRE_SIGNED_URL",
"CreationDate": 1548271795.471,
"Status": "Created",
"CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
"ImportedUsers": 0,
"SkippedUsers": 0,
"FailedUsers": 0
}
}
```
Upload the .csv file with curl using the pre-signed URL:
Command:
```
curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"
```
+ For API details, see [CreateUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-import-job.html) in *AWS CLI Command Reference*.
### `create-user-pool-client`
The following code example shows how to use `create-user-pool-client`.
**AWS CLI**
**To create a user pool client**
The following `create-user-pool-client` example creates a new user pool client with a client secret, explicit read and write attributes, sign in with username-password and SRP flows, sign-in with three IdPs, access to a subset of OAuth scopes, PinPoint analytics, and an extended authentication session validity.
```
aws cognito-idp create-user-pool-client \
--user-pool-id us-west-2_EXAMPLE \
--client-name MyTestClient \
--generate-secret \
--refresh-token-validity 10 \
--access-token-validity 60 \
--id-token-validity 60 \
--token-validity-units AccessToken=minutes,IdToken=minutes,RefreshToken=days \
--read-attributes email phone_number email_verified phone_number_verified \
--write-attributes email phone_number \
--explicit-auth-flows ALLOW_USER_PASSWORD_AUTH ALLOW_USER_SRP_AUTH ALLOW_REFRESH_TOKEN_AUTH \
--supported-identity-providers Google Facebook MyOIDC \
--callback-urls https://www.amazon.com https://example.com http://localhost:8001 myapp://example \
--allowed-o-auth-flows code implicit \
--allowed-o-auth-scopes openid profile aws.cognito.signin.user.admin solar-system-data/asteroids.add \
--allowed-o-auth-flows-user-pool-client \
--analytics-configuration ApplicationArn=arn:aws:mobiletargeting:us-west-2:767671399759:apps/thisisanexamplepinpointapplicationid,UserDataShared=TRUE \
--prevent-user-existence-errors ENABLED \
--enable-token-revocation \
--enable-propagate-additional-user-context-data \
--auth-session-validity 4
```
Output:
```
{
"UserPoolClient": {
"UserPoolId": "us-west-2_EXAMPLE",
"ClientName": "MyTestClient",
"ClientId": "123abc456defEXAMPLE",
"ClientSecret": "this1234is5678my91011example1213client1415secret",
"LastModifiedDate": 1726788459.464,
"CreationDate": 1726788459.464,
"RefreshTokenValidity": 10,
"AccessTokenValidity": 60,
"IdTokenValidity": 60,
"TokenValidityUnits": {
"AccessToken": "minutes",
"IdToken": "minutes",
"RefreshToken": "days"
},
"ReadAttributes": [
"email_verified",
"phone_number_verified",
"phone_number",
"email"
],
"WriteAttributes": [
"phone_number",
"email"
],
"ExplicitAuthFlows": [
"ALLOW_USER_PASSWORD_AUTH",
"ALLOW_USER_SRP_AUTH",
"ALLOW_REFRESH_TOKEN_AUTH"
],
"SupportedIdentityProviders": [
"Google",
"MyOIDC",
"Facebook"
],
"CallbackURLs": [
"https://example.com",
"https://www.amazon.com",
"myapp://example",
"http://localhost:8001"
],
"AllowedOAuthFlows": [
"implicit",
"code"
],
"AllowedOAuthScopes": [
"aws.cognito.signin.user.admin",
"openid",
"profile",
"solar-system-data/asteroids.add"
],
"AllowedOAuthFlowsUserPoolClient": true,
"AnalyticsConfiguration": {
"ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/thisisanexamplepinpointapplicationid",
"RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/cognito-idp.amazonaws.com/AWSServiceRoleForAmazonCognitoIdp",
"UserDataShared": true
},
"PreventUserExistenceErrors": "ENABLED",
"EnableTokenRevocation": true,
"EnablePropagateAdditionalUserContextData": true,
"AuthSessionValidity": 4
}
}
```
For more information, see [Application-specific settings with app clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [CreateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-client.html) in *AWS CLI Command Reference*.
### `create-user-pool-domain`
The following code example shows how to use `create-user-pool-domain`.
**AWS CLI**
**Example 1: To create a user pool domain**
The following `create-user-pool-domain` example creates a new custom domain.
```
aws cognito-idp create-user-pool-domain \
--user-pool-id us-west-2_EXAMPLE \
--domain auth.example.com \
--custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
```
Output:
```
{
"CloudFrontDomain": "example1domain.cloudfront.net"
}
```
For more information, see [Configuring a user pool domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) in the *Amazon Cognito Developer Guide*.
**Example 2: To create a user pool domain**
The following `create-user-pool-domain` example creates a new domain with a service-owned prefix.
```
aws cognito-idp create-user-pool-domain \
--user-pool-id us-west-2_EXAMPLE2 \
--domain mydomainprefix
```
For more information, see [Configuring a user pool domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [CreateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-domain.html) in *AWS CLI Command Reference*.
### `create-user-pool`
The following code example shows how to use `create-user-pool`.
**AWS CLI**
**To create a minimally configured user pool**
This example creates a user pool named MyUserPool using default values. There are no required attributes and no application clients. MFA and advanced security is disabled.
Command:
```
aws cognito-idp create-user-pool --pool-name MyUserPool
```
Output:
```
{
"UserPool": {
"SchemaAttributes": [
{
"Name": "sub",
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": true,
"AttributeDataType": "String",
"Mutable": false
},
{
"Name": "name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "given_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "family_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "middle_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "nickname",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "preferred_username",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "profile",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "picture",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "website",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "email",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "email_verified",
"Mutable": true
},
{
"Name": "gender",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "birthdate",
"StringAttributeConstraints": {
"MinLength": "10",
"MaxLength": "10"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "zoneinfo",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "locale",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "phone_number",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "phone_number_verified",
"Mutable": true
},
{
"Name": "address",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "updated_at",
"NumberAttributeConstraints": {
"MinValue": "0"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "Number",
"Mutable": true
}
],
"MfaConfiguration": "OFF",
"Name": "MyUserPool",
"LastModifiedDate": 1547833345.777,
"AdminCreateUserConfig": {
"UnusedAccountValidityDays": 7,
"AllowAdminCreateUserOnly": false
},
"EmailConfiguration": {},
"Policies": {
"PasswordPolicy": {
"RequireLowercase": true,
"RequireSymbols": true,
"RequireNumbers": true,
"MinimumLength": 8,
"RequireUppercase": true
}
},
"CreationDate": 1547833345.777,
"EstimatedNumberOfUsers": 0,
"Id": "us-west-2_aaaaaaaaa",
"LambdaConfig": {}
}
}
```
**To create a user pool with two required attributes**
This example creates a user pool MyUserPool. The pool is configured to accept email as a username attribute. It also sets the email source address to a validated address using Amazon Simple Email Service.
Command:
```
aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"
```
Output:
```
{
"UserPool": {
"SchemaAttributes": [
{
"Name": "sub",
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": true,
"AttributeDataType": "String",
"Mutable": false
},
{
"Name": "name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "given_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "family_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "middle_name",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "nickname",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "preferred_username",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "profile",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "picture",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "website",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "email",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "email_verified",
"Mutable": true
},
{
"Name": "gender",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "birthdate",
"StringAttributeConstraints": {
"MinLength": "10",
"MaxLength": "10"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "zoneinfo",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "locale",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "phone_number",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Required": false,
"Name": "phone_number_verified",
"Mutable": true
},
{
"Name": "address",
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "String",
"Mutable": true
},
{
"Name": "updated_at",
"NumberAttributeConstraints": {
"MinValue": "0"
},
"DeveloperOnlyAttribute": false,
"Required": false,
"AttributeDataType": "Number",
"Mutable": true
}
],
"MfaConfiguration": "OFF",
"Name": "MyUserPool",
"LastModifiedDate": 1547837788.189,
"AdminCreateUserConfig": {
"UnusedAccountValidityDays": 7,
"AllowAdminCreateUserOnly": false
},
"EmailConfiguration": {
"ReplyToEmailAddress": "jane@example.com",
"SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com"
},
"Policies": {
"PasswordPolicy": {
"RequireLowercase": true,
"RequireSymbols": true,
"RequireNumbers": true,
"MinimumLength": 8,
"RequireUppercase": true
}
},
"UsernameAttributes": [
"email"
],
"CreationDate": 1547837788.189,
"EstimatedNumberOfUsers": 0,
"Id": "us-west-2_aaaaaaaaa",
"LambdaConfig": {}
}
}
```
+ For API details, see [CreateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool.html) in *AWS CLI Command Reference*.
### `delete-group`
The following code example shows how to use `delete-group`.
**AWS CLI**
**To delete a group**
This example deletes a group.
Command:
```
aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName
```
+ For API details, see [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-group.html) in *AWS CLI Command Reference*.
### `delete-identity-provider`
The following code example shows how to use `delete-identity-provider`.
**AWS CLI**
**To delete an identity provider**
This example deletes an identity provider.
Command:
```
aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook
```
+ For API details, see [DeleteIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-identity-provider.html) in *AWS CLI Command Reference*.
### `delete-resource-server`
The following code example shows how to use `delete-resource-server`.
**AWS CLI**
**To delete a resource server**
This example deletes a resource server named weather.example.com.
Command:
```
aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com
```
+ For API details, see [DeleteResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-resource-server.html) in *AWS CLI Command Reference*.
### `delete-user-attributes`
The following code example shows how to use `delete-user-attributes`.
**AWS CLI**
**To delete a user attribute**
The following `delete-user-attributes` example deletes the custom attribute "custom:attribute" from the currently signed-in user.
```
aws cognito-idp delete-user-attributes \
--access-token ACCESS_TOKEN \
--user-attribute-names "custom:department"
```
This command produces no output.
For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [DeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-attributes.html) in *AWS CLI Command Reference*.
### `delete-user-pool-client`
The following code example shows how to use `delete-user-pool-client`.
**AWS CLI**
**To delete a user pool client**
This example deletes a user pool client.
Command:
```
aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0
```
+ For API details, see [DeleteUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-client.html) in *AWS CLI Command Reference*.
### `delete-user-pool-domain`
The following code example shows how to use `delete-user-pool-domain`.
**AWS CLI**
**To delete a user pool domain**
The following `delete-user-pool-domain` example deletes a user pool domain named `my-domain`
```
aws cognito-idp delete-user-pool-domain \
--user-pool-id us-west-2_aaaaaaaaa \
--domain my-domain
```
+ For API details, see [DeleteUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-domain.html) in *AWS CLI Command Reference*.
### `delete-user-pool`
The following code example shows how to use `delete-user-pool`.
**AWS CLI**
**To delete a user pool**
This example deletes a user pool using the user pool id, us-west-2\$1aaaaaaaaa.
Command:
```
aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa
```
+ For API details, see [DeleteUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool.html) in *AWS CLI Command Reference*.
### `delete-user`
The following code example shows how to use `delete-user`.
**AWS CLI**
**To delete a user**
This example deletes a user.
Command:
```
aws cognito-idp delete-user --access-token ACCESS_TOKEN
```
+ For API details, see [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user.html) in *AWS CLI Command Reference*.
### `describe-identity-provider`
The following code example shows how to use `describe-identity-provider`.
**AWS CLI**
**To describe an identity provider**
This example describes an identity provider named Facebook.
Command:
```
aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook
```
Output:
```
{
"IdentityProvider": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"ProviderName": "Facebook",
"ProviderType": "Facebook",
"ProviderDetails": {
"attributes_url": "https://graph.facebook.com/me?fields=",
"attributes_url_add_attributes": "true",
"authorize_scopes": myscope",
"authorize_url": "https://www.facebook.com/v2.9/dialog/oauth",
"client_id": "11111",
"client_secret": "11111",
"token_request_method": "GET",
"token_url": "https://graph.facebook.com/v2.9/oauth/access_token"
},
"AttributeMapping": {
"username": "id"
},
"IdpIdentifiers": [],
"LastModifiedDate": 1548105901.736,
"CreationDate": 1548105901.736
}
}
```
+ For API details, see [DescribeIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-identity-provider.html) in *AWS CLI Command Reference*.
### `describe-resource-server`
The following code example shows how to use `describe-resource-server`.
**AWS CLI**
**To describe a resource server**
This example describes the resource server weather.example.com.
Command:
```
aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com
```
Output:
```
{
"ResourceServer": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"Identifier": "weather.example.com",
"Name": "Weather",
"Scopes": [
{
"ScopeName": "weather.update",
"ScopeDescription": "Update weather forecast"
},
{
"ScopeName": "weather.read",
"ScopeDescription": "Read weather forecasts"
},
{
"ScopeName": "weather.delete",
"ScopeDescription": "Delete a weather forecast"
}
]
}
}
```
+ For API details, see [DescribeResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-resource-server.html) in *AWS CLI Command Reference*.
### `describe-risk-configuration`
The following code example shows how to use `describe-risk-configuration`.
**AWS CLI**
**To describe a risk configuration**
This example describes the risk configuration associated with pool us-west-2\$1aaaaaaaaa.
Command:
```
aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa
```
Output:
```
{
"RiskConfiguration": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"CompromisedCredentialsRiskConfiguration": {
"EventFilter": [
"SIGN_IN",
"SIGN_UP",
"PASSWORD_CHANGE"
],
"Actions": {
"EventAction": "BLOCK"
}
},
"AccountTakeoverRiskConfiguration": {
"NotifyConfiguration": {
"From": "diego@example.com",
"ReplyTo": "diego@example.com",
"SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com",
"BlockEmail": {
"Subject": "Blocked sign-in attempt",
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe blocked an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"NoActionEmail": {
"Subject": "New sign-in attempt",
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe observed an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"MfaEmail": {
"Subject": "New sign-in attempt",
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe required you to use multi-factor authentication for the following sign-in attempt:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
}
},
"Actions": {
"LowAction": {
"Notify": true,
"EventAction": "NO_ACTION"
},
"MediumAction": {
"Notify": true,
"EventAction": "MFA_IF_CONFIGURED"
},
"HighAction": {
"Notify": true,
"EventAction": "MFA_IF_CONFIGURED"
}
}
}
}
}
```
+ For API details, see [DescribeRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-risk-configuration.html) in *AWS CLI Command Reference*.
### `describe-user-import-job`
The following code example shows how to use `describe-user-import-job`.
**AWS CLI**
**To describe a user import job**
This example describes a user input job.
For more information about importing users, see Importing Users into User Pools From a CSV File.
Command:
```
aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW
```
Output:
```
{
"UserImportJob": {
"JobName": "import-Test1",
"JobId": "import-TZqNQvDRnW",
"UserPoolId": "us-west-2_aaaaaaaaa",
"PreSignedUrl": "PRE_SIGNED URL",
"CreationDate": 1548271708.512,
"Status": "Created",
"CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
"ImportedUsers": 0,
"SkippedUsers": 0,
"FailedUsers": 0
}
}
```
+ For API details, see [DescribeUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-import-job.html) in *AWS CLI Command Reference*.
### `describe-user-pool-client`
The following code example shows how to use `describe-user-pool-client`.
**AWS CLI**
**To describe a user pool client**
This example describes a user pool client.
Command:
```
aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0
```
Output:
```
{
"UserPoolClient": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"ClientName": "MyApp",
"ClientId": "38fjsnc484p94kpqsnet7mpld0",
"ClientSecret": "CLIENT_SECRET",
"LastModifiedDate": 1548108676.163,
"CreationDate": 1548108676.163,
"RefreshTokenValidity": 30,
"ReadAttributes": [
"address",
"birthdate",
"custom:CustomAttr1",
"custom:CustomAttr2",
"email",
"email_verified",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"phone_number_verified",
"picture",
"preferred_username",
"profile",
"updated_at",
"website",
"zoneinfo"
],
"WriteAttributes": [
"address",
"birthdate",
"custom:CustomAttr1",
"custom:CustomAttr2",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"updated_at",
"website",
"zoneinfo"
],
"ExplicitAuthFlows": [
"ADMIN_NO_SRP_AUTH",
"USER_PASSWORD_AUTH"
],
"AllowedOAuthFlowsUserPoolClient": false
}
}
```
+ For API details, see [DescribeUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-client.html) in *AWS CLI Command Reference*.
### `describe-user-pool-domain`
The following code example shows how to use `describe-user-pool-domain`.
**AWS CLI**
**To describe a user pool client**
This example describes a user pool domain named my-domain.
Command:
```
aws cognito-idp describe-user-pool-domain --domain my-domain
```
Output:
```
{
"DomainDescription": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"AWSAccountId": "111111111111",
"Domain": "my-domain",
"S3Bucket": "aws-cognito-prod-pdx-assets",
"CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net",
"Version": "20190128175402",
"Status": "ACTIVE",
"CustomDomainConfig": {}
}
}
```
+ For API details, see [DescribeUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-domain.html) in *AWS CLI Command Reference*.
### `describe-user-pool`
The following code example shows how to use `describe-user-pool`.
**AWS CLI**
**To describe a user pool**
The following example describes a user pool with the user pool id us-west-2\$1EXAMPLE.
```
aws cognito-idp describe-user-pool \
--user-pool-id us-west-2_EXAMPLE
```
Output:
```
{
"UserPool": {
"Id": "us-west-2_EXAMPLE",
"Name": "MyUserPool",
"Policies": {
"PasswordPolicy": {
"MinimumLength": 8,
"RequireUppercase": true,
"RequireLowercase": true,
"RequireNumbers": true,
"RequireSymbols": true,
"TemporaryPasswordValidityDays": 1
}
},
"DeletionProtection": "ACTIVE",
"LambdaConfig": {
"PreSignUp": "arn:aws:lambda:us-west-2:123456789012:function:MyPreSignUpFunction",
"CustomMessage": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomMessageFunction",
"PostConfirmation": "arn:aws:lambda:us-west-2:123456789012:function:MyPostConfirmationFunction",
"PreAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPreAuthenticationFunction",
"PostAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPostAuthenticationFunction",
"DefineAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyDefineAuthChallengeFunction",
"CreateAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyCreateAuthChallengeFunction",
"VerifyAuthChallengeResponse": "arn:aws:lambda:us-west-2:123456789012:function:MyVerifyAuthChallengeFunction",
"PreTokenGeneration": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction",
"UserMigration": "arn:aws:lambda:us-west-2:123456789012:function:MyMigrateUserFunction",
"PreTokenGenerationConfig": {
"LambdaVersion": "V2_0",
"LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction"
},
"CustomSMSSender": {
"LambdaVersion": "V1_0",
"LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomSMSSenderFunction"
},
"CustomEmailSender": {
"LambdaVersion": "V1_0",
"LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomEmailSenderFunction"
},
"KMSKeyID": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
},
"LastModifiedDate": 1726784814.598,
"CreationDate": 1602103465.273,
"SchemaAttributes": [
{
"Name": "sub",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": false,
"Required": true,
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "2048"
}
},
{
"Name": "name",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "given_name",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "family_name",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "middle_name",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "nickname",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "preferred_username",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "profile",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "picture",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "website",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "email",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": true,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "email_verified",
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false
},
{
"Name": "gender",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "birthdate",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "10",
"MaxLength": "10"
}
},
{
"Name": "zoneinfo",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "locale",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "phone_number",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "phone_number_verified",
"AttributeDataType": "Boolean",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false
},
{
"Name": "address",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "0",
"MaxLength": "2048"
}
},
{
"Name": "updated_at",
"AttributeDataType": "Number",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"NumberAttributeConstraints": {
"MinValue": "0"
}
},
{
"Name": "identities",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {}
},
{
"Name": "custom:111",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "256"
}
},
{
"Name": "dev:custom:222",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": true,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MinLength": "1",
"MaxLength": "421"
}
},
{
"Name": "custom:accesstoken",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MaxLength": "2048"
}
},
{
"Name": "custom:idtoken",
"AttributeDataType": "String",
"DeveloperOnlyAttribute": false,
"Mutable": true,
"Required": false,
"StringAttributeConstraints": {
"MaxLength": "2048"
}
}
],
"AutoVerifiedAttributes": [
"email"
],
"SmsVerificationMessage": "Your verification code is {####}. ",
"EmailVerificationMessage": "Your verification code is {####}. ",
"EmailVerificationSubject": "Your verification code",
"VerificationMessageTemplate": {
"SmsMessage": "Your verification code is {####}. ",
"EmailMessage": "Your verification code is {####}. ",
"EmailSubject": "Your verification code",
"EmailMessageByLink": "Please click the link below to verify your email address. {##Verify Your Email##}\n this is from us-west-2_ywDJHlIfU",
"EmailSubjectByLink": "Your verification link",
"DefaultEmailOption": "CONFIRM_WITH_LINK"
},
"SmsAuthenticationMessage": "Your verification code is {####}. ",
"UserAttributeUpdateSettings": {
"AttributesRequireVerificationBeforeUpdate": []
},
"MfaConfiguration": "OPTIONAL",
"DeviceConfiguration": {
"ChallengeRequiredOnNewDevice": true,
"DeviceOnlyRememberedOnUserPrompt": false
},
"EstimatedNumberOfUsers": 166,
"EmailConfiguration": {
"SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",
"EmailSendingAccount": "DEVELOPER"
},
"SmsConfiguration": {
"SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/userpool-SMS-Role",
"ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"SnsRegion": "us-west-2"
},
"UserPoolTags": {},
"Domain": "myCustomDomain",
"CustomDomain": "auth.example.com",
"AdminCreateUserConfig": {
"AllowAdminCreateUserOnly": false,
"UnusedAccountValidityDays": 1,
"InviteMessageTemplate": {
"SMSMessage": "Your username is {username} and temporary password is {####}. ",
"EmailMessage": "Your username is {username} and temporary password is {####}. ",
"EmailSubject": "Your temporary password"
}
},
"UserPoolAddOns": {
"AdvancedSecurityMode": "ENFORCED",
"AdvancedSecurityAdditionalFlows": {}
},
"Arn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE",
"AccountRecoverySetting": {
"RecoveryMechanisms": [
{
"Priority": 1,
"Name": "verified_email"
}
]
}
}
}
```
For more information, see [Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [DescribeUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool.html) in *AWS CLI Command Reference*.
### `forget-device`
The following code example shows how to use `forget-device`.
**AWS CLI**
**To forget a device**
This example forgets device a device.
Command:
```
aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678
```
+ For API details, see [ForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forget-device.html) in *AWS CLI Command Reference*.
### `forgot-password`
The following code example shows how to use `forgot-password`.
**AWS CLI**
**To force a password change**
The following `forgot-password` example sends a message to jane@example.com to change their password.
```
aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com
```
Output:
```
{
"CodeDeliveryDetails": {
"Destination": "j***@e***.com",
"DeliveryMedium": "EMAIL",
"AttributeName": "email"
}
}
```
+ For API details, see [ForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forgot-password.html) in *AWS CLI Command Reference*.
### `get-csv-header`
The following code example shows how to use `get-csv-header`.
**AWS CLI**
**To create a csv header**
This example creates a csv header.
For more information about importing users, see Importing Users into User Pools From a CSV File.
Command:
```
aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa
```
Output:
```
{
"UserPoolId": "us-west-2_aaaaaaaaa",
"CSVHeader": [
"name",
"given_name",
"family_name",
"middle_name",
"nickname",
"preferred_username",
"profile",
"picture",
"website",
"email",
"email_verified",
"gender",
"birthdate",
"zoneinfo",
"locale",
"phone_number",
"phone_number_verified",
"address",
"updated_at",
"cognito:mfa_enabled",
"cognito:username"
]
}
```
... Importing Users into User Pools From a CSV File: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html
+ For API details, see [GetCsvHeader](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-csv-header.html) in *AWS CLI Command Reference*.
### `get-device`
The following code example shows how to use `get-device`.
**AWS CLI**
**To get a device**
The following `get-device` example displays one device for currently signed-in user.
```
aws cognito-idp get-device \
--access-token eyJra456defEXAMPLE \
--device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"Device": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "device_name",
"Value": "MyDevice"
},
{
"Name": "dev:device_arn",
"Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"Name": "dev:device_owner",
"Value": "diego.us-west-2_EXAMPLE"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.1"
},
{
"Name": "dev:device_remembered_status",
"Value": "remembered"
},
{
"Name": "dev:device_sdk",
"Value": "aws-sdk"
}
],
"DeviceCreateDate": 1715100742.022,
"DeviceLastModifiedDate": 1723233651.167,
"DeviceLastAuthenticatedDate": 1715100742.0
}
}
```
For more information, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-device.html) in *AWS CLI Command Reference*.
### `get-group`
The following code example shows how to use `get-group`.
**AWS CLI**
**To get information about a group**
The following `get-group` example lists the properties of the user group named `MyGroup`. This group has a precedence and an IAM role associated with it.
```
aws cognito-idp get-group \
--user-pool-id us-west-2_EXAMPLE \
--group-name MyGroup
```
Output:
```
{
"Group": {
"GroupName": "MyGroup",
"UserPoolId": "us-west-2_EXAMPLE",
"RoleArn": "arn:aws:iam::123456789012:role/example-cognito-role",
"Precedence": 7,
"LastModifiedDate": 1697211218.305,
"CreationDate": 1611685503.954
}
}
```
For more information, see [Adding groups to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-group.html) in *AWS CLI Command Reference*.
### `get-identity-provider-by-identifier`
The following code example shows how to use `get-identity-provider-by-identifier`.
**AWS CLI**
**To get the configuration of an identity provider from the IdP identifier**
The following `get-identity-provider-by-identifier` example returns the configuration of the identity provider with the identifier `mysso`.
```
aws cognito-idp get-identity-provider-by-identifier \
--user-pool-id us-west-2_EXAMPLE \
--idp-identifier mysso
```
Output:
```
{
"IdentityProvider": {
"UserPoolId": "us-west-2_EXAMPLE",
"ProviderName": "MYSAML",
"ProviderType": "SAML",
"ProviderDetails": {
"ActiveEncryptionCertificate": "[Certificate contents]",
"IDPSignout": "false",
"MetadataURL": "https://auth.example.com/saml/metadata/",
"SLORedirectBindingURI": "https://auth.example.com/saml/logout/",
"SSORedirectBindingURI": "https://auth.example.com/saml/assertion/"
},
"AttributeMapping": {
"email": "email"
},
"IdpIdentifiers": [
"mysso",
"mysamlsso"
],
"LastModifiedDate": 1705616729.188,
"CreationDate": 1643734622.919
}
}
```
For more information, see [Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetIdentityProviderByIdentifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-identity-provider-by-identifier.html) in *AWS CLI Command Reference*.
### `get-log-delivery-configuration`
The following code example shows how to use `get-log-delivery-configuration`.
**AWS CLI**
**To display the log delivery configuration**
The following `get-log-delivery-configuration` example displays the log export settings of the requested user pool.
```
aws cognito-idp get-log-delivery-configuration \
--user-pool-id us-west-2_EXAMPLE
```
Output:
```
{
"LogDeliveryConfiguration": {
"UserPoolId": "us-west-2_EXAMPLE",
"LogConfigurations": [
{
"LogLevel": "INFO",
"EventSource": "userAuthEvents",
"FirehoseConfiguration": {
"StreamArn": "arn:aws:firehose:us-west-2:123456789012:deliverystream/my-test-deliverystream"
}
},
{
"LogLevel": "ERROR",
"EventSource": "userNotification",
"CloudWatchLogsConfiguration": {
"LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:my-message-delivery-logs"
}
}
]
}
}
```
For more information, see [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-log-delivery-configuration.html) in *AWS CLI Command Reference*.
### `get-signing-certificate`
The following code example shows how to use `get-signing-certificate`.
**AWS CLI**
**To display the SAML signing certificate**
The following `get-signing-certificate` example displays the SAML 2.0 signing certificate for the request user pool.
```
aws cognito-idp get-signing-certificate \
--user-pool-id us-west-2_EXAMPLE
```
Output:
```
{
"Certificate": "[Certificate content]"
}
```
For more information, see [SAML signing and encryption](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-signing-certificate.html) in *AWS CLI Command Reference*.
### `get-ui-customization`
The following code example shows how to use `get-ui-customization`.
**AWS CLI**
**To display the classic hosted UI customization settings for an app client**
The following `get-ui-customization` example displays the classic hosted UI customization settings for an app client that doesn't inherit settings from the user pool.
```
aws cognito-idp get-ui-customization \
--user-pool-id us-west-2_EXAMPLE \
--client-id 1example23456789
```
Output:
```
{
"UICustomization": {
"UserPoolId": "us-west-2_EXAMPLE",
"ClientId": "1example23456789",
"ImageUrl": "https://example.cloudfront.net/us-west-2_EXAMPLE/1example23456789/20250115191928/assets/images/image.jpg",
"CSS": "\n.logo-customizable {\n max-width: 80%;\n max-height: 30%;\n}\n\n.banner-customizable {\n padding: 25px 0px 25px 0px;\n background-color: lightgray;\n}\n\n.label-customizable {\n font-weight: 400;\n}\n\n.textDescription-customizable {\n padding-top: 100px;\n padding-bottom: 10px;\n display: block;\n font-size: 12px;\n}\n\n.idpDescription-customizable {\n padding-top: 10px;\n padding-bottom: 10px;\n display: block;\n font-size: 16px;\n}\n\n.legalText-customizable {\n color: #747474;\n font-size: 11px;\n}\n\n.submitButton-customizable {\n font-size: 14px;\n font-weight: bold;\n margin: 20px 0px 10px 0px;\n height: 50px;\n width: 100%;\n color: #fff;\n background-color: #337ab7;\n}\n\n.submitButton-customizable:hover {\n color: #fff;\n background-color: #286090;\n}\n\n.errorMessage-customizable {\n padding: 5px;\n font-size: 12px;\n width: 100%;\n background: #F5F5F5;\n border: 2px solid #D64958;\n color: #D64958;\n}\n\n.inputField-customizable {\n width: 100%;\n height: 34px;\n color: #555;\n background-color: #fff;\n border: 1px solid #ccc;\n}\n\n.inputField-customizable:focus {\n border-color: #66afe9;\n outline: 0;\n}\n\n.idpButton-customizable {\n height: 40px;\n width: 100%;\n width: 100%;\n text-align: center;\n margin-bottom: 15px;\n color: #fff;\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n\n.idpButton-customizable:hover {\n color: #fff;\n background-color: #31b0d5;\n}\n\n.socialButton-customizable {\n border-radius: 2px;\n height: 60px;\n margin-bottom: 15px;\n padding: 1px;\n text-align: left;\n width: 100%;\n}\n\n.redirect-customizable {\n text-align: center;\n}\n\n.passwordCheck-notValid-customizable {\n color: #DF3312;\n}\n\n.passwordCheck-valid-customizable {\n color: #19BF00;\n}\n\n.background-customizable {\n background-color: #fff;\n}\n",
"CSSVersion": "20250115191928"
}
}
```
For more information, see [Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-ui-customization.html) in *AWS CLI Command Reference*.
### `get-user-attribute-verification-code`
The following code example shows how to use `get-user-attribute-verification-code`.
**AWS CLI**
**To send an attribute verification code to the current user**
The following `get-user-attribute-verification-code` example sends an attribute verification code to the currently signed-in user's email address.
```
aws cognito-idp get-user-attribute-verification-code \
--access-token eyJra456defEXAMPLE \
--attribute-name email
```
Output:
```
{
"CodeDeliveryDetails": {
"Destination": "a***@e***",
"DeliveryMedium": "EMAIL",
"AttributeName": "email"
}
}
```
For more information, see [Signing up and confirming user accounts](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetUserAttributeVerificationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-attribute-verification-code.html) in *AWS CLI Command Reference*.
### `get-user-auth-factors`
The following code example shows how to use `get-user-auth-factors`.
**AWS CLI**
**To list the authentication factors available to the current user**
The following `get-user-auth-factors` example lists the available authentication factors for the currently signed-in user.
```
aws cognito-idp get-user-auth-factors \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"Username": "testuser",
"ConfiguredUserAuthFactors": [
"PASSWORD",
"EMAIL_OTP",
"SMS_OTP",
"WEB_AUTHN"
]
}
```
For more information, see [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetUserAuthFactors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-auth-factors.html) in *AWS CLI Command Reference*.
### `get-user-pool-mfa-config`
The following code example shows how to use `get-user-pool-mfa-config`.
**AWS CLI**
**To display the multi-factor authentication and WebAuthn settings of a user pool**
The following `get-user-pool-mfa-config` example displays the MFA and WebAuthn configuration of the requested user pool.
```
aws cognito-idp get-user-pool-mfa-config \
--user-pool-id us-west-2_EXAMPLE
```
Output:
```
{
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
"SmsConfiguration": {
"SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/my-SMS-Role",
"ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"SnsRegion": "us-west-2"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": true
},
"EmailMfaConfiguration": {
"Message": "Your OTP for MFA or sign-in: use {####}",
"Subject": "OTP test"
},
"MfaConfiguration": "OPTIONAL",
"WebAuthnConfiguration": {
"RelyingPartyId": "auth.example.com",
"UserVerification": "preferred"
}
}
```
For more information, see [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-pool-mfa-config.html) in *AWS CLI Command Reference*.
### `get-user`
The following code example shows how to use `get-user`.
**AWS CLI**
**To get the details of the current user**
The following `get-user` example displays the profile of the currently signed-in user.
```
aws cognito-idp get-user \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"Username": "johndoe",
"UserAttributes": [
{
"Name": "sub",
"Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
},
{
"Name": "identities",
"Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]"
},
{
"Name": "email_verified",
"Value": "true"
},
{
"Name": "custom:state",
"Value": "Maine"
},
{
"Name": "name",
"Value": "John Doe"
},
{
"Name": "phone_number_verified",
"Value": "true"
},
{
"Name": "phone_number",
"Value": "+12065551212"
},
{
"Name": "preferred_username",
"Value": "jamesdoe"
},
{
"Name": "locale",
"Value": "EMEA"
},
{
"Name": "email",
"Value": "jamesdoe@example.com"
}
]
}
```
For more information, see [Managing users](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user.html) in *AWS CLI Command Reference*.
### `global-sign-out`
The following code example shows how to use `global-sign-out`.
**AWS CLI**
**To sign out the current user**
The following `global-sign-out` example signs out the current user.
```
aws cognito-idp global-sign-out \
--access-token eyJra456defEXAMPLE
```
This command produces no output.
For more information, see [Managing users](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [GlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/global-sign-out.html) in *AWS CLI Command Reference*.
### `initiate-auth`
The following code example shows how to use `initiate-auth`.
**AWS CLI**
**To sign in a user**
The following `initiate-auth` example signs in a user with the basic username-password flow and no additional challenges.
```
aws cognito-idp initiate-auth \
--auth-flow USER_PASSWORD_AUTH \
--client-id 1example23456789 \
--analytics-metadata AnalyticsEndpointId=d70b2ba36a8c4dc5a04a0451aEXAMPLE \
--auth-parameters USERNAME=testuser,PASSWORD=[Password] --user-context-data EncodedData=mycontextdata --client-metadata MyTestKey=MyTestValue
```
Output:
```
{
"AuthenticationResult": {
"AccessToken": "eyJra456defEXAMPLE",
"ExpiresIn": 3600,
"TokenType": "Bearer",
"RefreshToken": "eyJra123abcEXAMPLE",
"IdToken": "eyJra789ghiEXAMPLE",
"NewDeviceMetadata": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceGroupKey": "-v7w9UcY6"
}
}
}
```
For more information, see [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [InitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/initiate-auth.html) in *AWS CLI Command Reference*.
### `list-devices`
The following code example shows how to use `list-devices`.
**AWS CLI**
**To list a user's devices**
The following `list-devices` example lists the devices that the current user has registered.
```
aws cognito-idp list-devices \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"Devices": [
{
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "device_name",
"Value": "Dart-device"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.1"
}
],
"DeviceCreateDate": 1715100742.022,
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceLastAuthenticatedDate": 1715100742.0,
"DeviceLastModifiedDate": 1723233651.167
},
{
"DeviceAttributes": [
{
"Name": "device_status",
"Value": "valid"
},
{
"Name": "last_ip_used",
"Value": "192.0.2.2"
}
],
"DeviceCreateDate": 1726856147.993,
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"DeviceLastAuthenticatedDate": 1726856147.0,
"DeviceLastModifiedDate": 1726856147.993
}
]
}
```
For more information, see [Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-devices.html) in *AWS CLI Command Reference*.
### `list-groups`
The following code example shows how to use `list-groups`.
**AWS CLI**
**To list the groups in a user pool**
The following `list-groups` example lists the first two groups in the requested user pool.
```
aws cognito-idp list-groups \
--user-pool-id us-west-2_EXAMPLE \
--max-items 2
```
Output:
```
{
"Groups": [
{
"CreationDate": 1681760899.633,
"Description": "My test group",
"GroupName": "testgroup",
"LastModifiedDate": 1681760899.633,
"Precedence": 1,
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"CreationDate": 1642632749.051,
"Description": "Autogenerated group for users who sign in using Facebook",
"GroupName": "us-west-2_EXAMPLE_Facebook",
"LastModifiedDate": 1642632749.051,
"UserPoolId": "us-west-2_EXAMPLE"
}
],
"NextToken": "[Pagination token]"
}
```
For more information, see [Adding groups to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-groups.html) in *AWS CLI Command Reference*.
### `list-identity-providers`
The following code example shows how to use `list-identity-providers`.
**AWS CLI**
**To list identity providers**
The following `list-identity-providers` example lists the first two identity providers in the requested user pool.
```
aws cognito-idp list-identity-providers \
--user-pool-id us-west-2_EXAMPLE \
--max-items 2
```
Output:
```
{
"Providers": [
{
"CreationDate": 1619477386.504,
"LastModifiedDate": 1703798328.142,
"ProviderName": "Azure",
"ProviderType": "SAML"
},
{
"CreationDate": 1642698776.175,
"LastModifiedDate": 1642699086.453,
"ProviderName": "LoginWithAmazon",
"ProviderType": "LoginWithAmazon"
}
],
"NextToken": "[Pagination token]"
}
```
For more information, see [Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListIdentityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-identity-providers.html) in *AWS CLI Command Reference*.
### `list-resource-servers`
The following code example shows how to use `list-resource-servers`.
**AWS CLI**
**To list resource servers**
The following `list-resource-servers` example lists the first two resource servers in the requested user pool.
```
aws cognito-idp list-resource-servers \
--user-pool-id us-west-2_EXAMPLE \
--max-results 2
```
Output:
```
{
"ResourceServers": [
{
"Identifier": "myapi.example.com",
"Name": "Example API with custom access control scopes",
"Scopes": [
{
"ScopeDescription": "International customers",
"ScopeName": "international.read"
},
{
"ScopeDescription": "Domestic customers",
"ScopeName": "domestic.read"
}
],
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"Identifier": "myapi2.example.com",
"Name": "Another example API for access control",
"Scopes": [
{
"ScopeDescription": "B2B customers",
"ScopeName": "b2b.read"
}
],
"UserPoolId": "us-west-2_EXAMPLE"
}
],
"NextToken": "[Pagination token]"
}
```
For more information, see [Access control with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListResourceServers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-resource-servers.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list user pool tags**
The following `list-tags-for-resource` example lists the tags assigned to the user pool with the requested ARN.
```
aws cognito-idp list-tags-for-resource \
--resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE
```
Output:
```
{
"Tags": {
"administrator": "Jie",
"tenant": "ExampleCorp"
}
}
```
For more information, see [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `list-user-import-jobs`
The following code example shows how to use `list-user-import-jobs`.
**AWS CLI**
**To list user import jobs and statuses**
The following `list-user-import-jobs` example lists first three user import jobs and their details in the requested user pool.
```
aws cognito-idp list-user-import-jobs \
--user-pool-id us-west-2_EXAMPLE \
--max-results 3
```
Output:
```
{
"PaginationToken": "us-west-2_EXAMPLE#import-example3#1667948397084",
"UserImportJobs": [
{
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role",
"CompletionDate": 1735329786.142,
"CompletionMessage": "The user import job has expired.",
"CreationDate": 1735241621.022,
"FailedUsers": 0,
"ImportedUsers": 0,
"JobId": "import-example1",
"JobName": "Test-import-job-1",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"Status": "Expired",
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role",
"CompletionDate": 1681509058.408,
"CompletionMessage": "Too many users have failed or been skipped during the import.",
"CreationDate": 1681509001.477,
"FailedUsers": 1,
"ImportedUsers": 0,
"JobId": "import-example2",
"JobName": "Test-import-job-2",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"StartDate": 1681509057.965,
"Status": "Failed",
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role",
"CompletionDate": 1.667864578676E9,
"CompletionMessage": "Import Job Completed Successfully.",
"CreationDate": 1.667864480281E9,
"FailedUsers": 0,
"ImportedUsers": 6,
"JobId": "import-example3",
"JobName": "Test-import-job-3",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"StartDate": 1.667864578167E9,
"Status": "Succeeded",
"UserPoolId": "us-west-2_EXAMPLE"
}
]
}
```
For more information, see [Importing users from a CSV file](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListUserImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-import-jobs.html) in *AWS CLI Command Reference*.
### `list-user-pool-clients`
The following code example shows how to use `list-user-pool-clients`.
**AWS CLI**
**To list app clients**
The following `list-user-pool-clients` example lists the first three app clients in the requested user pool.
```
aws cognito-idp list-user-pool-clients \
--user-pool-id us-west-2_EXAMPLE \
--max-results 3
```
Output:
```
{
"NextToken": "[Pagination token]",
"UserPoolClients": [
{
"ClientId": "1example23456789",
"ClientName": "app-client-1",
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"ClientId": "2example34567890",
"ClientName": "app-client-2",
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"ClientId": "3example45678901",
"ClientName": "app-client-3",
"UserPoolId": "us-west-2_EXAMPLE"
}
]
}
```
For more information, see [App clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListUserPoolClients](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pool-clients.html) in *AWS CLI Command Reference*.
### `list-user-pools`
The following code example shows how to use `list-user-pools`.
**AWS CLI**
**To list user pools**
The following `list-user-pools` example lists 3 of the available user pools in the AWS account of the current CLI credentials.
```
aws cognito-idp list-user-pools \
--max-results 3
```
Output:
```
{
"NextToken": "[Pagination token]",
"UserPools": [
{
"CreationDate": 1681502497.741,
"Id": "us-west-2_EXAMPLE1",
"LambdaConfig": {
"CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
"PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
"PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
"PreTokenGenerationConfig": {
"LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction",
"LambdaVersion": "V1_0"
}
},
"LastModifiedDate": 1681502497.741,
"Name": "user pool 1"
},
{
"CreationDate": 1686064178.717,
"Id": "us-west-2_EXAMPLE2",
"LambdaConfig": {
},
"LastModifiedDate": 1686064178.873,
"Name": "user pool 2"
},
{
"CreationDate": 1627681712.237,
"Id": "us-west-2_EXAMPLE3",
"LambdaConfig": {
"UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
},
"LastModifiedDate": 1678486942.479,
"Name": "user pool 3"
}
]
}
```
For more information, see [Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListUserPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pools.html) in *AWS CLI Command Reference*.
### `list-users-in-group`
The following code example shows how to use `list-users-in-group`.
**AWS CLI**
**To list users in a group**
This example lists users in group MyGroup.
Command:
```
aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup
```
Output:
```
{
"Users": [
{
"Username": "acf10624-80bb-401a-ac61-607bee2110ec",
"Attributes": [
{
"Name": "sub",
"Value": "acf10624-80bb-401a-ac61-607bee2110ec"
},
{
"Name": "custom:CustomAttr1",
"Value": "New Value!"
},
{
"Name": "email",
"Value": "jane@example.com"
}
],
"UserCreateDate": 1548102770.284,
"UserLastModifiedDate": 1548103204.893,
"Enabled": true,
"UserStatus": "CONFIRMED"
},
{
"Username": "22704aa3-fc10-479a-97eb-2af5806bd327",
"Attributes": [
{
"Name": "sub",
"Value": "22704aa3-fc10-479a-97eb-2af5806bd327"
},
{
"Name": "email_verified",
"Value": "true"
},
{
"Name": "email",
"Value": "diego@example.com"
}
],
"UserCreateDate": 1548089817.683,
"UserLastModifiedDate": 1548089817.683,
"Enabled": true,
"UserStatus": "FORCE_CHANGE_PASSWORD"
}
]
}
```
+ For API details, see [ListUsersInGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users-in-group.html) in *AWS CLI Command Reference*.
### `list-users`
The following code example shows how to use `list-users`.
**AWS CLI**
**Example 1: To list users with a server-side filter**
The following `list-users` example lists 3 users in the requested user pool whose email addresses begin with `testuser`.
```
aws cognito-idp list-users \
--user-pool-id us-west-2_EXAMPLE \
--filter email^=\"testuser\" \
--max-items 3
```
Output:
```
{
"PaginationToken": "efgh5678EXAMPLE",
"Users": [
{
"Attributes": [
{
"Name": "sub",
"Value": "eaad0219-2117-439f-8d46-4db20e59268f"
},
{
"Name": "email",
"Value": "testuser@example.com"
}
],
"Enabled": true,
"UserCreateDate": 1682955829.578,
"UserLastModifiedDate": 1689030181.63,
"UserStatus": "CONFIRMED",
"Username": "testuser"
},
{
"Attributes": [
{
"Name": "sub",
"Value": "3b994cfd-0b07-4581-be46-3c82f9a70c90"
},
{
"Name": "email",
"Value": "testuser2@example.com"
}
],
"Enabled": true,
"UserCreateDate": 1684427979.201,
"UserLastModifiedDate": 1684427979.201,
"UserStatus": "UNCONFIRMED",
"Username": "testuser2"
},
{
"Attributes": [
{
"Name": "sub",
"Value": "5929e0d1-4c34-42d1-9b79-a5ecacfe66f7"
},
{
"Name": "email",
"Value": "testuser3@example.com"
}
],
"Enabled": true,
"UserCreateDate": 1684427823.641,
"UserLastModifiedDate": 1684427823.641,
"UserStatus": "UNCONFIRMED",
"Username": "testuser3@example.com"
}
]
}
```
For more information, see [Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html) in the *Amazon Cognito Developer Guide*.
**Example 2: To list users with a client-side filter**
The following `list-users` example lists the attributes of three users who have an attribute, in this case their email address, that contains the email domain "@example.com". If other attributes contained this string, they would also be displayed. The second user has no attributes that match the query and is excluded from the displayed output, but not from the server response.
```
aws cognito-idp list-users \
--user-pool-id us-west-2_EXAMPLE \
--max-items 3
--query Users\[\*\].Attributes\[\?Value\.contains\(\@\,\'@example.com\'\)\]
```
Output:
```
[
[
{
"Name": "email",
"Value": "admin@example.com"
}
],
[],
[
{
"Name": "email",
"Value": "operator@example.com"
}
]
]
```
For more information, see [Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users.html) in *AWS CLI Command Reference*.
### `list-web-authn-credentials`
The following code example shows how to use `list-web-authn-credentials`.
**AWS CLI**
**To list passkey credentials**
The following `list-web-authn-credentials` example lists passkey, or WebAuthn, credentials for the current user. They have one registered device.
```
aws cognito-idp list-web-authn-credentials \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"Credentials": [
{
"AuthenticatorAttachment": "cross-platform",
"CreatedAt": 1736293876.115,
"CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE",
"FriendlyCredentialName": "Roaming passkey",
"RelyingPartyId": "auth.example.com"
}
]
}
```
For more information, see [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ListWebAuthnCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-web-authn-credentials.html) in *AWS CLI Command Reference*.
### `resend-confirmation-code`
The following code example shows how to use `resend-confirmation-code`.
**AWS CLI**
**To resend a confirmation code**
The following `resend-confirmation-code` example sends a confirmation code to the user `jane`.
```
aws cognito-idp resend-confirmation-code \
--client-id 12a3b456c7de890f11g123hijk \
--username jane
```
Output:
```
{
"CodeDeliveryDetails": {
"Destination": "j***@e***.com",
"DeliveryMedium": "EMAIL",
"AttributeName": "email"
}
}
```
For more information, see [Signing up and confirming user accounts](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [ResendConfirmationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/resend-confirmation-code.html) in *AWS CLI Command Reference*.
### `respond-to-auth-challenge`
The following code example shows how to use `respond-to-auth-challenge`.
**AWS CLI**
**Example 1: To respond to a NEW\$1PASSWORD\$1REQUIRED challenge**
The following `respond-to-auth-challenge` example responds to a NEW\$1PASSWORD\$1REQUIRED challenge that initiate-auth returned. It sets a password for the user `jane@example.com`.
```
aws cognito-idp respond-to-auth-challenge \
--client-id 1example23456789 \
--challenge-name NEW_PASSWORD_REQUIRED \
--challenge-responses USERNAME=jane@example.com,NEW_PASSWORD=[Password] \
--session AYABeEv5HklEXAMPLE
```
Output:
```
{
"ChallengeParameters": {},
"AuthenticationResult": {
"AccessToken": "ACCESS_TOKEN",
"ExpiresIn": 3600,
"TokenType": "Bearer",
"RefreshToken": "REFRESH_TOKEN",
"IdToken": "ID_TOKEN",
"NewDeviceMetadata": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceGroupKey": "-wt2ha1Zd"
}
}
}
```
For more information, see [Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html) in the *Amazon Cognito Developer Guide*.
**Example 2: To respond to a SELECT\$1MFA\$1TYPE challenge**
The following `respond-to-auth-challenge` example chooses TOTP MFA as the MFA option for the current user. The user was prompted to select an MFA type and will next be prompted to enter their MFA code.
```
aws cognito-idp respond-to-auth-challenge \
--client-id 1example23456789
--session AYABeEv5HklEXAMPLE
--challenge-name SELECT_MFA_TYPE
--challenge-responses USERNAME=testuser,ANSWER=SOFTWARE_TOKEN_MFA
```
Output:
```
{
"ChallengeName": "SOFTWARE_TOKEN_MFA",
"Session": "AYABeEv5HklEXAMPLE",
"ChallengeParameters": {
"FRIENDLY_DEVICE_NAME": "transparent"
}
}
```
For more information, see [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) in the *Amazon Cognito Developer Guide*.
**Example 3: To respond to a SOFTWARE\$1TOKEN\$1MFA challenge**
The following `respond-to-auth-challenge` example provides a TOTP MFA code and completes sign-in.
```
aws cognito-idp respond-to-auth-challenge \
--client-id 1example23456789 \
--session AYABeEv5HklEXAMPLE \
--challenge-name SOFTWARE_TOKEN_MFA \
--challenge-responses USERNAME=testuser,SOFTWARE_TOKEN_MFA_CODE=123456
```
Output:
```
{
"AuthenticationResult": {
"AccessToken": "eyJra456defEXAMPLE",
"ExpiresIn": 3600,
"TokenType": "Bearer",
"RefreshToken": "eyJra123abcEXAMPLE",
"IdToken": "eyJra789ghiEXAMPLE",
"NewDeviceMetadata": {
"DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceGroupKey": "-v7w9UcY6"
}
}
}
```
For more information, see [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [RespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/respond-to-auth-challenge.html) in *AWS CLI Command Reference*.
### `revoke-token`
The following code example shows how to use `revoke-token`.
**AWS CLI**
**To revoke a refresh token**
The following `revoke-token` revokes the requested refresh token and associated access tokens.
```
aws cognito-idp revoke-token \
--token eyJjd123abcEXAMPLE \
--client-id 1example23456789
```
This command produces no output.
For more information, see [Revoking tokens](https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [RevokeToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/revoke-token.html) in *AWS CLI Command Reference*.
### `set-log-delivery-configuration`
The following code example shows how to use `set-log-delivery-configuration`.
**AWS CLI**
**To set up log export from a user pool**
The following `set-log-delivery-configuration` example configures the requested user pool with user-notification error logging to a log group and user-authentication info logging to an S3 bucket.
```
aws cognito-idp set-log-delivery-configuration \
--user-pool-id us-west-2_EXAMPLE \
--log-configurations LogLevel=ERROR,EventSource=userNotification,CloudWatchLogsConfiguration={LogGroupArn=arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported} LogLevel=INFO,EventSource=userAuthEvents,S3Configuration={BucketArn=arn:aws:s3:::amzn-s3-demo-bucket1}
```
Output:
```
{
"LogDeliveryConfiguration": {
"LogConfigurations": [
{
"CloudWatchLogsConfiguration": {
"LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported"
},
"EventSource": "userNotification",
"LogLevel": "ERROR"
},
{
"EventSource": "userAuthEvents",
"LogLevel": "INFO",
"S3Configuration": {
"BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1"
}
}
],
"UserPoolId": "us-west-2_EXAMPLE"
}
}
```
For more information, see [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [SetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-log-delivery-configuration.html) in *AWS CLI Command Reference*.
### `set-risk-configuration`
The following code example shows how to use `set-risk-configuration`.
**AWS CLI**
**To set the threat protection risk configuration**
The following `set-risk-configuration` example configures threat protection messages and actions, compromised credentials, and IP address exceptions in the requested app client. Because of the complexity of the NotifyConfiguration object, JSON input is a best practice for this command.
```
aws cognito-idp set-risk-configuration \
--cli-input-json file://set-risk-configuration.json
```
Contents of `set-risk-configuration.json`:
```
{
"AccountTakeoverRiskConfiguration": {
"Actions": {
"HighAction": {
"EventAction": "MFA_REQUIRED",
"Notify": true
},
"LowAction": {
"EventAction": "NO_ACTION",
"Notify": true
},
"MediumAction": {
"EventAction": "MFA_IF_CONFIGURED",
"Notify": true
}
},
"NotifyConfiguration": {
"BlockEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe blocked an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "Blocked sign-in attempt",
"TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"From": "admin@example.com",
"MfaEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe required you to use multi-factor authentication for the following sign-in attempt:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "New sign-in attempt",
"TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"NoActionEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe observed an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "New sign-in attempt",
"TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"ReplyTo": "admin@example.com",
"SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com"
}
},
"ClientId": "1example23456789",
"CompromisedCredentialsRiskConfiguration": {
"Actions": {
"EventAction": "BLOCK"
},
"EventFilter": [
"PASSWORD_CHANGE",
"SIGN_UP",
"SIGN_IN"
]
},
"RiskExceptionConfiguration": {
"BlockedIPRangeList": [
"192.0.2.1/32",
"192.0.2.2/32"
],
"SkippedIPRangeList": [
"203.0.113.1/32",
"203.0.113.2/32"
]
},
"UserPoolId": "us-west-2_EXAMPLE"
}
```
Output:
```
{
"RiskConfiguration": {
"AccountTakeoverRiskConfiguration": {
"Actions": {
"HighAction": {
"EventAction": "MFA_REQUIRED",
"Notify": true
},
"LowAction": {
"EventAction": "NO_ACTION",
"Notify": true
},
"MediumAction": {
"EventAction": "MFA_IF_CONFIGURED",
"Notify": true
}
},
"NotifyConfiguration": {
"BlockEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe blocked an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "Blocked sign-in attempt",
"TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"From": "admin@example.com",
"MfaEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe required you to use multi-factor authentication for the following sign-in attempt:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "New sign-in attempt",
"TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"NoActionEmail": {
"HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\nWe observed an unrecognized sign-in to your account with this information:\n
\n- Time: {login-time}
\n- Device: {device-name}
\n- Location: {city}, {country}
\n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know\n\n",
"Subject": "New sign-in attempt",
"TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
},
"ReplyTo": "admin@example.com",
"SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com"
}
},
"ClientId": "1example23456789",
"CompromisedCredentialsRiskConfiguration": {
"Actions": {
"EventAction": "BLOCK"
},
"EventFilter": [
"PASSWORD_CHANGE",
"SIGN_UP",
"SIGN_IN"
]
},
"RiskExceptionConfiguration": {
"BlockedIPRangeList": [
"192.0.2.1/32",
"192.0.2.2/32"
],
"SkippedIPRangeList": [
"203.0.113.1/32",
"203.0.113.2/32"
]
},
"UserPoolId": "us-west-2_EXAMPLE"
}
}
```
For more information, see [Threat protection](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [SetRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-risk-configuration.html) in *AWS CLI Command Reference*.
### `set-ui-customization`
The following code example shows how to use `set-ui-customization`.
**AWS CLI**
**Example 1: To customize the classic hosted UI for an app client**
The following `set-ui-customization` example configures the requested app client with some custom CSS and with the Amazon Cognito logo as the application logo.
```
aws cognito-idp set-ui-customization \
--user-pool-id us-west-2_ywDJHlIfU \
--client-id 14pq32c5q2uq2q7keorloqvb23 \
--css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \
--image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC
```
Output:
```
{
"UICustomization": {
"UserPoolId": "us-west-2_ywDJHlIfU",
"ClientId": "14pq32c5q2uq2q7keorloqvb23",
"ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg",
"CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n",
"CSSVersion": "20250117005911"
}
}
```
**Example 2: To set the default UI customization for all app clients**
The following `set-ui-customization` example configures the requested user pool for all app clients that don't have a client-specific configuration. The command applies some custom CSS and with the Amazon Cognito logo as the application logo.
```
aws cognito-idp set-ui-customization \
--user-pool-id us-west-2_ywDJHlIfU \
--client-id ALL \
--css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \
--image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC
```
Output:
```
{
"UICustomization": {
"UserPoolId": "us-west-2_ywDJHlIfU",
"ClientId": "14pq32c5q2uq2q7keorloqvb23",
"ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg",
"CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n",
"CSSVersion": "20250117005911"
}
}
```
For more information, see [Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [SetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-ui-customization.html) in *AWS CLI Command Reference*.
### `set-user-mfa-preference`
The following code example shows how to use `set-user-mfa-preference`.
**AWS CLI**
**To set a user's MFA preference**
The following `set-user-mfa-preference` example configures the current user to use TOTP MFA and disables all other MFA factors.
```
aws cognito-idp set-user-mfa-preference \
--access-token eyJra456defEXAMPLE \
--software-token-mfa-settings Enabled=true,PreferredMfa=true \
--sms-mfa-settings Enabled=false,PreferredMfa=false \
--email-mfa-settings Enabled=false,PreferredMfa=false
```
This command produces no output.
For more information, see [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [SetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-mfa-preference.html) in *AWS CLI Command Reference*.
### `set-user-pool-mfa-config`
The following code example shows how to use `set-user-pool-mfa-config`.
**AWS CLI**
**To configure user pool MFA and WebAuthn**
The following `set-user-pool-mfa-config` example configures the requested user pool with optional MFA with all available MFA methods, and sets the WebAuthn configuration.
```
aws cognito-idp set-user-pool-mfa-config \
--user-pool-id us-west-2_EXAMPLE \
--sms-mfa-configuration "SmsAuthenticationMessage=\"Your OTP for MFA or sign-in: use {####}.\",SmsConfiguration={SnsCallerArn=arn:aws:iam::123456789012:role/service-role/test-SMS-Role,ExternalId=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,SnsRegion=us-west-2}" \
--software-token-mfa-configuration Enabled=true \
--email-mfa-configuration "Message=\"Your OTP for MFA or sign-in: use {####}\",Subject=\"OTP test\"" \
--mfa-configuration OPTIONAL \
--web-authn-configuration RelyingPartyId=auth.example.com,UserVerification=preferred
```
Output:
```
{
"EmailMfaConfiguration": {
"Message": "Your OTP for MFA or sign-in: use {####}",
"Subject": "OTP test"
},
"MfaConfiguration": "OPTIONAL",
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
"SmsConfiguration": {
"ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role",
"SnsRegion": "us-west-2"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": true
},
"WebAuthnConfiguration": {
"RelyingPartyId": "auth.example.com",
"UserVerification": "preferred"
}
}
```
For more information, see [Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) and [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) in the *Amazon Cognito Developer Guide*.
+ For API details, see [SetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-pool-mfa-config.html) in *AWS CLI Command Reference*.
### `set-user-settings`
The following code example shows how to use `set-user-settings`.
**AWS CLI**
**To set user settings**
This example sets the MFA delivery preference to EMAIL.
Command:
```
aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL
```
+ For API details, see [SetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-settings.html) in *AWS CLI Command Reference*.
### `sign-up`
The following code example shows how to use `sign-up`.
**AWS CLI**
**To sign up a user**
This example signs up jane@example.com.
Command:
```
aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"
```
Output:
```
{
"UserConfirmed": false,
"UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862"
}
```
+ For API details, see [SignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/sign-up.html) in *AWS CLI Command Reference*.
### `start-user-import-job`
The following code example shows how to use `start-user-import-job`.
**AWS CLI**
**To start an import job**
The following `start-user-import-job` example starts the requested import job in the requested user pool.
```
aws cognito-idp start-user-import-job \
--user-pool-id us-west-2_EXAMPLE \
--job-id import-mAgUtd8PMm
```
Output:
```
{
"UserImportJob": {
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role",
"CreationDate": 1736442975.904,
"FailedUsers": 0,
"ImportedUsers": 0,
"JobId": "import-mAgUtd8PMm",
"JobName": "Customer import",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"StartDate": 1736443020.081,
"Status": "Pending",
"UserPoolId": "us-west-2_EXAMPLE"
}
}
```
For more information, see [Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [StartUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-user-import-job.html) in *AWS CLI Command Reference*.
### `start-web-authn-registration`
The following code example shows how to use `start-web-authn-registration`.
**AWS CLI**
**To get passkey registration information for a signed-in user**
The following `start-web-authn-registration` example generates WebAuthn registration options for the current user.
```
aws cognito-idp start-web-authn-registration \
--access-token eyJra456defEXAMPLE
```
Output:
```
{
"CredentialCreationOptions": {
"authenticatorSelection": {
"requireResidentKey": true,
"residentKey": "required",
"userVerification": "preferred"
},
"challenge": "wxvbDicyqQqvF2EXAMPLE",
"excludeCredentials": [
{
"id": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE",
"type": "public-key"
}
],
"pubKeyCredParams": [
{
"alg": -7,
"type": "public-key"
},
{
"alg": -257,
"type": "public-key"
}
],
"rp": {
"id": "auth.example.com",
"name": "auth.example.com"
},
"timeout": 60000,
"user": {
"displayName": "testuser",
"id": "ZWFhZDAyMTktMjExNy00MzlmLThkNDYtNGRiMjBlNEXAMPLE",
"name": "testuser"
}
}
}
```
For more information, see [Passkey sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey) in the *Amazon Cognito Developer Guide*.
+ For API details, see [StartWebAuthnRegistration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-web-authn-registration.html) in *AWS CLI Command Reference*.
### `stop-user-import-job`
The following code example shows how to use `stop-user-import-job`.
**AWS CLI**
**To stop an import job**
The following `stop-user-import-job` example stops the requested running user import job in the requested user pool.
```
aws cognito-idp stop-user-import-job \
--user-pool-id us-west-2_EXAMPLE \
--job-id import-mAgUtd8PMm
```
Output:
```
{
"UserImportJob": {
"CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role",
"CompletionDate": 1736443496.379,
"CompletionMessage": "The Import Job was stopped by the developer.",
"CreationDate": 1736443471.781,
"FailedUsers": 0,
"ImportedUsers": 0,
"JobId": "import-mAgUtd8PMm",
"JobName": "Customer import",
"PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
"SkippedUsers": 0,
"StartDate": 1736443494.154,
"Status": "Stopped",
"UserPoolId": "us-west-2_EXAMPLE"
}
}
```
For more information, see [Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [StopUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/stop-user-import-job.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To tag a user pool**
The following `tag-resource` example applies `administrator` and `department` tags to the requested user pool.
```
aws cognito-idp tag-resource \
--resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE \
--tags administrator=Jie,tenant=ExampleCorp
```
This command produces no output.
For more information, see [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove tags from a user pool**
The following `untag-resource` example removes `administrator` and `department` tags from the requested user pool.
```
aws cognito-idp untag-resource \
--resource-arn arn:aws:cognito-idp:us-west-2:767671399759:userpool/us-west-2_l5cxwdm2K \
--tag-keys administrator tenant
```
This command produces no output.
For more information, see [Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/untag-resource.html) in *AWS CLI Command Reference*.
### `update-auth-event-feedback`
The following code example shows how to use `update-auth-event-feedback`.
**AWS CLI**
**To update auth event feedback**
This example updates authorization event feedback. It marks the event "Valid".
Command:
```
aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid"
```
+ For API details, see [UpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-auth-event-feedback.html) in *AWS CLI Command Reference*.
### `update-device-status`
The following code example shows how to use `update-device-status`.
**AWS CLI**
**To update device status**
This example updates the status for a device to "not\$1remembered".
Command:
```
aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered"
```
+ For API details, see [UpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-device-status.html) in *AWS CLI Command Reference*.
### `update-group`
The following code example shows how to use `update-group`.
**AWS CLI**
**To update a group**
This example updates the description and precedence for MyGroup.
Command:
```
aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2
```
Output:
```
{
"Group": {
"GroupName": "MyGroup",
"UserPoolId": "us-west-2_aaaaaaaaa",
"Description": "New description",
"RoleArn": "arn:aws:iam::111111111111:role/MyRole",
"Precedence": 2,
"LastModifiedDate": 1548800862.812,
"CreationDate": 1548097827.125
}
}
```
+ For API details, see [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-group.html) in *AWS CLI Command Reference*.
### `update-identity-provider`
The following code example shows how to use `update-identity-provider`.
**AWS CLI**
**To update a user pool identity provider**
The following `update-identity-provider` example updates the OIDC provider "MyOIDCIdP" in the requested user pool.
```
aws cognito-idp update-identity-provider \
--cli-input-json file://update-identity-provider.json
```
Contents of `update-identity-provider.json`:
```
{
"AttributeMapping": {
"email": "idp_email",
"email_verified": "idp_email_verified",
"username": "sub"
},
"CreationDate": 1.701129701653E9,
"IdpIdentifiers": [
"corp",
"dev"
],
"LastModifiedDate": 1.701129701653E9,
"ProviderDetails": {
"attributes_request_method": "GET",
"attributes_url": "https://example.com/userInfo",
"attributes_url_add_attributes": "false",
"authorize_scopes": "openid profile",
"authorize_url": "https://example.com/authorize",
"client_id": "idpexampleclient123",
"client_secret": "idpexamplesecret456",
"jwks_uri": "https://example.com/.well-known/jwks.json",
"oidc_issuer": "https://example.com",
"token_url": "https://example.com/token"
},
"ProviderName": "MyOIDCIdP",
"UserPoolId": "us-west-2_EXAMPLE"
}
```
Output:
```
{
"IdentityProvider": {
"AttributeMapping": {
"email": "idp_email",
"email_verified": "idp_email_verified",
"username": "sub"
},
"CreationDate": 1701129701.653,
"IdpIdentifiers": [
"corp",
"dev"
],
"LastModifiedDate": 1736444278.211,
"ProviderDetails": {
"attributes_request_method": "GET",
"attributes_url": "https://example.com/userInfo",
"attributes_url_add_attributes": "false",
"authorize_scopes": "openid profile",
"authorize_url": "https://example.com/authorize",
"client_id": "idpexampleclient123",
"client_secret": "idpexamplesecret456",
"jwks_uri": "https://example.com/.well-known/jwks.json",
"oidc_issuer": "https://example.com",
"token_url": "https://example.com/token"
},
"ProviderName": "MyOIDCIdP",
"ProviderType": "OIDC",
"UserPoolId": "us-west-2_EXAMPLE"
}
}
```
For more information, see [Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UpdateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-identity-provider.html) in *AWS CLI Command Reference*.
### `update-managed-login-branding`
The following code example shows how to use `update-managed-login-branding`.
**AWS CLI**
**To update a managed login branding style**
The following `update-managed-login-branding` example updates the requested app client branding style.
```
aws cognito-idp update-managed-login-branding \
--cli-input-json file://update-managed-login-branding.json
```
Contents of `update-managed-login-branding.json`:
```
{
"Assets": [
{
"Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=",
"Category": "PAGE_FOOTER_BACKGROUND",
"ColorMode": "DARK",
"Extension": "SVG"
}
],
"ManagedLoginBrandingId": "63f30090-6b1f-4278-b885-2bbb81f8e545",
"Settings": {
"categories": {
"auth": {
"authMethodOrder": [
[
{
"display": "BUTTON",
"type": "FEDERATED"
},
{
"display": "INPUT",
"type": "USERNAME_PASSWORD"
}
]
],
"federation": {
"interfaceStyle": "BUTTON_LIST",
"order": [
]
}
},
"form": {
"displayGraphics": true,
"instructions": {
"enabled": false
},
"languageSelector": {
"enabled": false
},
"location": {
"horizontal": "CENTER",
"vertical": "CENTER"
},
"sessionTimerDisplay": "NONE"
},
"global": {
"colorSchemeMode": "LIGHT",
"pageFooter": {
"enabled": false
},
"pageHeader": {
"enabled": false
},
"spacingDensity": "REGULAR"
},
"signUp": {
"acceptanceElements": [
{
"enforcement": "NONE",
"textKey": "en"
}
]
}
},
"componentClasses": {
"buttons": {
"borderRadius": 8.0
},
"divider": {
"darkMode": {
"borderColor": "232b37ff"
},
"lightMode": {
"borderColor": "ebebf0ff"
}
},
"dropDown": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"itemBackgroundColor": "192534ff"
},
"hover": {
"itemBackgroundColor": "081120ff",
"itemBorderColor": "5f6b7aff",
"itemTextColor": "e9ebedff"
},
"match": {
"itemBackgroundColor": "d1d5dbff",
"itemTextColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"itemBackgroundColor": "ffffffff"
},
"hover": {
"itemBackgroundColor": "f4f4f4ff",
"itemBorderColor": "7d8998ff",
"itemTextColor": "000716ff"
},
"match": {
"itemBackgroundColor": "414d5cff",
"itemTextColor": "0972d3ff"
}
}
},
"focusState": {
"darkMode": {
"borderColor": "539fe5ff"
},
"lightMode": {
"borderColor": "0972d3ff"
}
},
"idpButtons": {
"icons": {
"enabled": true
}
},
"input": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "5f6b7aff"
},
"placeholderColor": "8d99a8ff"
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"placeholderColor": "5f6b7aff"
}
},
"inputDescription": {
"darkMode": {
"textColor": "8d99a8ff"
},
"lightMode": {
"textColor": "5f6b7aff"
}
},
"inputLabel": {
"darkMode": {
"textColor": "d1d5dbff"
},
"lightMode": {
"textColor": "000716ff"
}
},
"link": {
"darkMode": {
"defaults": {
"textColor": "539fe5ff"
},
"hover": {
"textColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"textColor": "0972d3ff"
},
"hover": {
"textColor": "033160ff"
}
}
},
"optionControls": {
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "539fe5ff",
"foregroundColor": "000716ff"
}
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "0972d3ff",
"foregroundColor": "ffffffff"
}
}
},
"statusIndicator": {
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff",
"indicatorColor": "eb6f6fff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "001a02ff",
"borderColor": "29ad32ff",
"indicatorColor": "29ad32ff"
},
"warning": {
"backgroundColor": "1d1906ff",
"borderColor": "e0ca57ff",
"indicatorColor": "e0ca57ff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff",
"indicatorColor": "d91515ff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "f2fcf3ff",
"borderColor": "037f0cff",
"indicatorColor": "037f0cff"
},
"warning": {
"backgroundColor": "fffce9ff",
"borderColor": "8d6605ff",
"indicatorColor": "8d6605ff"
}
}
}
},
"components": {
"alert": {
"borderRadius": 12.0,
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff"
}
}
},
"favicon": {
"enabledTypes": [
"ICO",
"SVG"
]
},
"form": {
"backgroundImage": {
"enabled": false
},
"borderRadius": 8.0,
"darkMode": {
"backgroundColor": "0f1b2aff",
"borderColor": "424650ff"
},
"lightMode": {
"backgroundColor": "ffffffff",
"borderColor": "c6c6cdff"
},
"logo": {
"enabled": false,
"formInclusion": "IN",
"location": "CENTER",
"position": "TOP"
}
},
"idpButton": {
"custom": {
},
"standard": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "c6c6cdff",
"textColor": "c6c6cdff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "424650ff",
"textColor": "424650ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
},
"pageBackground": {
"darkMode": {
"color": "0f1b2aff"
},
"image": {
"enabled": true
},
"lightMode": {
"color": "ffffffff"
}
},
"pageFooter": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": false,
"location": "START"
}
},
"pageHeader": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": false,
"location": "START"
}
},
"pageText": {
"darkMode": {
"bodyColor": "b6bec9ff",
"descriptionColor": "b6bec9ff",
"headingColor": "d1d5dbff"
},
"lightMode": {
"bodyColor": "414d5cff",
"descriptionColor": "414d5cff",
"headingColor": "000716ff"
}
},
"phoneNumberSelector": {
"displayType": "TEXT"
},
"primaryButton": {
"darkMode": {
"active": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"defaults": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "89bdeeff",
"textColor": "000716ff"
}
},
"lightMode": {
"active": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
},
"defaults": {
"backgroundColor": "0972d3ff",
"textColor": "ffffffff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
}
}
},
"secondaryButton": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "539fe5ff",
"textColor": "539fe5ff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "0972d3ff",
"textColor": "0972d3ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
}
},
"UseCognitoProvidedValues": false,
"UserPoolId": "ca-central-1_EXAMPLE"
}
```
Output:
```
{
"ManagedLoginBranding": {
"Assets": [
{
"Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=",
"Category": "PAGE_FOOTER_BACKGROUND",
"ColorMode": "DARK",
"Extension": "SVG"
}
],
"CreationDate": 1732138490.642,
"LastModifiedDate": 1732140420.301,
"ManagedLoginBrandingId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Settings": {
"categories": {
"auth": {
"authMethodOrder": [
[
{
"display": "BUTTON",
"type": "FEDERATED"
},
{
"display": "INPUT",
"type": "USERNAME_PASSWORD"
}
]
],
"federation": {
"interfaceStyle": "BUTTON_LIST",
"order": [
]
}
},
"form": {
"displayGraphics": true,
"instructions": {
"enabled": false
},
"languageSelector": {
"enabled": false
},
"location": {
"horizontal": "CENTER",
"vertical": "CENTER"
},
"sessionTimerDisplay": "NONE"
},
"global": {
"colorSchemeMode": "LIGHT",
"pageFooter": {
"enabled": false
},
"pageHeader": {
"enabled": false
},
"spacingDensity": "REGULAR"
},
"signUp": {
"acceptanceElements": [
{
"enforcement": "NONE",
"textKey": "en"
}
]
}
},
"componentClasses": {
"buttons": {
"borderRadius": 8.0
},
"divider": {
"darkMode": {
"borderColor": "232b37ff"
},
"lightMode": {
"borderColor": "ebebf0ff"
}
},
"dropDown": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"itemBackgroundColor": "192534ff"
},
"hover": {
"itemBackgroundColor": "081120ff",
"itemBorderColor": "5f6b7aff",
"itemTextColor": "e9ebedff"
},
"match": {
"itemBackgroundColor": "d1d5dbff",
"itemTextColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"itemBackgroundColor": "ffffffff"
},
"hover": {
"itemBackgroundColor": "f4f4f4ff",
"itemBorderColor": "7d8998ff",
"itemTextColor": "000716ff"
},
"match": {
"itemBackgroundColor": "414d5cff",
"itemTextColor": "0972d3ff"
}
}
},
"focusState": {
"darkMode": {
"borderColor": "539fe5ff"
},
"lightMode": {
"borderColor": "0972d3ff"
}
},
"idpButtons": {
"icons": {
"enabled": true
}
},
"input": {
"borderRadius": 8.0,
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "5f6b7aff"
},
"placeholderColor": "8d99a8ff"
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"placeholderColor": "5f6b7aff"
}
},
"inputDescription": {
"darkMode": {
"textColor": "8d99a8ff"
},
"lightMode": {
"textColor": "5f6b7aff"
}
},
"inputLabel": {
"darkMode": {
"textColor": "d1d5dbff"
},
"lightMode": {
"textColor": "000716ff"
}
},
"link": {
"darkMode": {
"defaults": {
"textColor": "539fe5ff"
},
"hover": {
"textColor": "89bdeeff"
}
},
"lightMode": {
"defaults": {
"textColor": "0972d3ff"
},
"hover": {
"textColor": "033160ff"
}
}
},
"optionControls": {
"darkMode": {
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "539fe5ff",
"foregroundColor": "000716ff"
}
},
"lightMode": {
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "7d8998ff"
},
"selected": {
"backgroundColor": "0972d3ff",
"foregroundColor": "ffffffff"
}
}
},
"statusIndicator": {
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff",
"indicatorColor": "eb6f6fff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "001a02ff",
"borderColor": "29ad32ff",
"indicatorColor": "29ad32ff"
},
"warning": {
"backgroundColor": "1d1906ff",
"borderColor": "e0ca57ff",
"indicatorColor": "e0ca57ff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff",
"indicatorColor": "d91515ff"
},
"pending": {
"indicatorColor": "AAAAAAAA"
},
"success": {
"backgroundColor": "f2fcf3ff",
"borderColor": "037f0cff",
"indicatorColor": "037f0cff"
},
"warning": {
"backgroundColor": "fffce9ff",
"borderColor": "8d6605ff",
"indicatorColor": "8d6605ff"
}
}
}
},
"components": {
"alert": {
"borderRadius": 12.0,
"darkMode": {
"error": {
"backgroundColor": "1a0000ff",
"borderColor": "eb6f6fff"
}
},
"lightMode": {
"error": {
"backgroundColor": "fff7f7ff",
"borderColor": "d91515ff"
}
}
},
"favicon": {
"enabledTypes": [
"ICO",
"SVG"
]
},
"form": {
"backgroundImage": {
"enabled": false
},
"borderRadius": 8.0,
"darkMode": {
"backgroundColor": "0f1b2aff",
"borderColor": "424650ff"
},
"lightMode": {
"backgroundColor": "ffffffff",
"borderColor": "c6c6cdff"
},
"logo": {
"enabled": false,
"formInclusion": "IN",
"location": "CENTER",
"position": "TOP"
}
},
"idpButton": {
"custom": {
},
"standard": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "c6c6cdff",
"textColor": "c6c6cdff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "424650ff",
"textColor": "424650ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
},
"pageBackground": {
"darkMode": {
"color": "0f1b2aff"
},
"image": {
"enabled": true
},
"lightMode": {
"color": "ffffffff"
}
},
"pageFooter": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": false,
"location": "START"
}
},
"pageHeader": {
"backgroundImage": {
"enabled": false
},
"darkMode": {
"background": {
"color": "0f141aff"
},
"borderColor": "424650ff"
},
"lightMode": {
"background": {
"color": "fafafaff"
},
"borderColor": "d5dbdbff"
},
"logo": {
"enabled": false,
"location": "START"
}
},
"pageText": {
"darkMode": {
"bodyColor": "b6bec9ff",
"descriptionColor": "b6bec9ff",
"headingColor": "d1d5dbff"
},
"lightMode": {
"bodyColor": "414d5cff",
"descriptionColor": "414d5cff",
"headingColor": "000716ff"
}
},
"phoneNumberSelector": {
"displayType": "TEXT"
},
"primaryButton": {
"darkMode": {
"active": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"defaults": {
"backgroundColor": "539fe5ff",
"textColor": "000716ff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "89bdeeff",
"textColor": "000716ff"
}
},
"lightMode": {
"active": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
},
"defaults": {
"backgroundColor": "0972d3ff",
"textColor": "ffffffff"
},
"disabled": {
"backgroundColor": "ffffffff",
"borderColor": "ffffffff"
},
"hover": {
"backgroundColor": "033160ff",
"textColor": "ffffffff"
}
}
},
"secondaryButton": {
"darkMode": {
"active": {
"backgroundColor": "354150ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
},
"defaults": {
"backgroundColor": "0f1b2aff",
"borderColor": "539fe5ff",
"textColor": "539fe5ff"
},
"hover": {
"backgroundColor": "192534ff",
"borderColor": "89bdeeff",
"textColor": "89bdeeff"
}
},
"lightMode": {
"active": {
"backgroundColor": "d3e7f9ff",
"borderColor": "033160ff",
"textColor": "033160ff"
},
"defaults": {
"backgroundColor": "ffffffff",
"borderColor": "0972d3ff",
"textColor": "0972d3ff"
},
"hover": {
"backgroundColor": "f2f8fdff",
"borderColor": "033160ff",
"textColor": "033160ff"
}
}
}
}
},
"UseCognitoProvidedValues": false,
"UserPoolId": "ca-central-1_EXAMPLE"
}
}
```
For more information, see [Apply branding to managed login pages](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-branding.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UpdateManagedLoginBranding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-managed-login-branding.html) in *AWS CLI Command Reference*.
### `update-resource-server`
The following code example shows how to use `update-resource-server`.
**AWS CLI**
**To update a resource server**
This example updates the the resource server Weather. It adds a new scope.
Command:
```
aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description"
```
Output:
```
{
"ResourceServer": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"Identifier": "weather.example.com",
"Name": "Happy",
"Scopes": [
{
"ScopeName": "NewScope",
"ScopeDescription": "New scope description"
}
]
}
}
```
+ For API details, see [UpdateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-resource-server.html) in *AWS CLI Command Reference*.
### `update-user-attributes`
The following code example shows how to use `update-user-attributes`.
**AWS CLI**
**To update user attributes**
This example updates the user attribute "nickname".
Command:
```
aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan"
```
+ For API details, see [UpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-attributes.html) in *AWS CLI Command Reference*.
### `update-user-pool-client`
The following code example shows how to use `update-user-pool-client`.
**AWS CLI**
**To update an app client**
The following `update-user-pool-client` example updates the configuration of the requested app client.
```
aws cognito-idp update-user-pool-client \
--user-pool-id us-west-2_EXAMPLE \
--client-id 1example23456789 \
--client-name my-test-app \
--refresh-token-validity 30 \
--access-token-validity 60 \
--id-token-validity 60 \
--token-validity-units AccessToken=minutes,IdToken=minutes,RefreshToken=days \
--read-attributes "address" "birthdate" "email" "email_verified" "family_name" "gender" "locale" "middle_name" "name" "nickname" "phone_number" "phone_number_verified" "picture" "preferred_username" "profile" "updated_at" "website" "zoneinfo" \
--write-attributes "address" "birthdate" "email" "family_name" "gender" "locale" "middle_name" "name" "nickname" "phone_number" "picture" "preferred_username" "profile" "updated_at" "website" "zoneinfo" \
--explicit-auth-flows "ALLOW_ADMIN_USER_PASSWORD_AUTH" "ALLOW_CUSTOM_AUTH" "ALLOW_REFRESH_TOKEN_AUTH" "ALLOW_USER_PASSWORD_AUTH" "ALLOW_USER_SRP_AUTH" \
--supported-identity-providers "MySAML" "COGNITO" "Google" \
--callback-urls "https://www.example.com" "https://app2.example.com" \
--logout-urls "https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com" "https://example.com/logout" \
--default-redirect-uri "https://www.example.com" \
--allowed-o-auth-flows "code" "implicit" \
--allowed-o-auth-scopes "openid" "profile" "aws.cognito.signin.user.admin" \
--allowed-o-auth-flows-user-pool-client \
--prevent-user-existence-errors ENABLED \
--enable-token-revocation \
--no-enable-propagate-additional-user-context-data \
--auth-session-validity 3
```
Output:
```
{
"UserPoolClient": {
"UserPoolId": "us-west-2_EXAMPLE",
"ClientName": "my-test-app",
"ClientId": "1example23456789",
"LastModifiedDate": "2025-01-31T14:40:12.498000-08:00",
"CreationDate": "2023-09-13T16:26:34.408000-07:00",
"RefreshTokenValidity": 30,
"AccessTokenValidity": 60,
"IdTokenValidity": 60,
"TokenValidityUnits": {
"AccessToken": "minutes",
"IdToken": "minutes",
"RefreshToken": "days"
},
"ReadAttributes": [
"website",
"zoneinfo",
"address",
"birthdate",
"email_verified",
"gender",
"profile",
"phone_number_verified",
"preferred_username",
"locale",
"middle_name",
"picture",
"updated_at",
"name",
"nickname",
"phone_number",
"family_name",
"email"
],
"WriteAttributes": [
"website",
"zoneinfo",
"address",
"birthdate",
"gender",
"profile",
"preferred_username",
"locale",
"middle_name",
"picture",
"updated_at",
"name",
"nickname",
"phone_number",
"family_name",
"email"
],
"ExplicitAuthFlows": [
"ALLOW_CUSTOM_AUTH",
"ALLOW_USER_PASSWORD_AUTH",
"ALLOW_ADMIN_USER_PASSWORD_AUTH",
"ALLOW_USER_SRP_AUTH",
"ALLOW_REFRESH_TOKEN_AUTH"
],
"SupportedIdentityProviders": [
"Google",
"COGNITO",
"MySAML"
],
"CallbackURLs": [
"https://www.example.com",
"https://app2.example.com"
],
"LogoutURLs": [
"https://example.com/logout",
"https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com"
],
"DefaultRedirectURI": "https://www.example.com",
"AllowedOAuthFlows": [
"implicit",
"code"
],
"AllowedOAuthScopes": [
"aws.cognito.signin.user.admin",
"openid",
"profile"
],
"AllowedOAuthFlowsUserPoolClient": true,
"PreventUserExistenceErrors": "ENABLED",
"EnableTokenRevocation": true,
"EnablePropagateAdditionalUserContextData": false,
"AuthSessionValidity": 3
}
}
```
For more information, see [Application-specific settings with app clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UpdateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-client.html) in *AWS CLI Command Reference*.
### `update-user-pool-domain`
The following code example shows how to use `update-user-pool-domain`.
**AWS CLI**
**To update a custom domain**
The following `update-user-pool-domain` example configures the branding version and certificate for the custom domain the requested user pool.
```
aws cognito-idp update-user-pool-domain \
--user-pool-id ca-central-1_EXAMPLE \
--domain auth.example.com \
--managed-login-version 2 \
--custom-domain-config CertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"CloudFrontDomain": "example.cloudfront.net",
"ManagedLoginVersion": 2
}
```
For more information, see [Managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) and [Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UpdateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-domain.html) in *AWS CLI Command Reference*.
### `update-user-pool`
The following code example shows how to use `update-user-pool`.
**AWS CLI**
**To update a user pool**
The following `update-user-pool` example modifies a user pool with example syntax for each of the available configuration options. To update a user pool, you must specify all previously-configured options or they will reset to a default value.
```
aws cognito-idp update-user-pool --user-pool-id us-west-2_EXAMPLE \
--policies PasswordPolicy=\{MinimumLength=6,RequireUppercase=true,RequireLowercase=true,RequireNumbers=true,RequireSymbols=true,TemporaryPasswordValidityDays=7\} \
--deletion-protection ACTIVE \
--lambda-config PreSignUp="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-presignup-function",PreTokenGeneration="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-pretoken-function" \
--auto-verified-attributes "phone_number" "email" \
--verification-message-template \{\"SmsMessage\":\""Your code is {####}"\",\"EmailMessage\":\""Your code is {####}"\",\"EmailSubject\":\""Your verification code"\",\"EmailMessageByLink\":\""Click {##here##} to verify your email address."\",\"EmailSubjectByLink\":\""Your verification link"\",\"DefaultEmailOption\":\"CONFIRM_WITH_LINK\"\} \
--sms-authentication-message "Your code is {####}" \
--user-attribute-update-settings AttributesRequireVerificationBeforeUpdate="email","phone_number" \
--mfa-configuration "OPTIONAL" \
--device-configuration ChallengeRequiredOnNewDevice=true,DeviceOnlyRememberedOnUserPrompt=true \
--email-configuration SourceArn="arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",ReplyToEmailAddress="amdin+noreply@example.com",EmailSendingAccount=DEVELOPER,From="admin@amazon.com",ConfigurationSet="test-configuration-set" \
--sms-configuration SnsCallerArn="arn:aws:iam::123456789012:role/service-role/SNS-SMS-Role",ExternalId="12345",SnsRegion="us-west-2" \
--admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \
--user-pool-tags "Function"="MyMobileGame","Developers"="Berlin" \
--admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \
--user-pool-add-ons AdvancedSecurityMode="AUDIT" \
--account-recovery-setting RecoveryMechanisms=\[\{Priority=1,Name="verified_email"\},\{Priority=2,Name="verified_phone_number"\}\]
```
This command produces no output.
For more information, see [Updating user pool configuration](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-updating.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [UpdateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool.html) in *AWS CLI Command Reference*.
### `verify-software-token`
The following code example shows how to use `verify-software-token`.
**AWS CLI**
**To confirm registration of a TOTP authenticator**
The following `verify-software-token` example completes TOTP registration for the current user.
```
aws cognito-idp verify-software-token \
--access-token eyJra456defEXAMPLE \
--user-code 123456
```
Output:
```
{
"Status": "SUCCESS"
}
```
For more information, see [Adding MFA to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [VerifySoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-software-token.html) in *AWS CLI Command Reference*.
### `verify-user-attribute`
The following code example shows how to use `verify-user-attribute`.
**AWS CLI**
**To verify an attribute change**
The following `verify-user-attribute` example verifies a change to the current user's email attribute.
```
aws cognito-idp verify-user-attribute \
--access-token eyJra456defEXAMPLE \
--attribute-name email \
--code 123456
```
For more information, see [Configuring email or phone verification](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html) in the *Amazon Cognito Developer Guide*.
+ For API details, see [VerifyUserAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-user-attribute.html) in *AWS CLI Command Reference*.
# Amazon Comprehend examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Comprehend.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `batch-detect-dominant-language`
The following code example shows how to use `batch-detect-dominant-language`.
**AWS CLI**
**To detect the dominant language of multiple input texts**
The following `batch-detect-dominant-language` example analyzes multiple input texts and returns the dominant language of each. The pre-trained models confidence score is also output for each prediction.
```
aws comprehend batch-detect-dominant-language \
--text-list "Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force."
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"Languages": [
{
"LanguageCode": "en",
"Score": 0.9986501932144165
}
]
}
],
"ErrorList": []
}
```
For more information, see [Dominant Language](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-dominant-language.html) in *AWS CLI Command Reference*.
### `batch-detect-entities`
The following code example shows how to use `batch-detect-entities`.
**AWS CLI**
**To detect entities from multiple input texts**
The following `batch-detect-entities` example analyzes multiple input texts and returns the named entities of each. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend batch-detect-entities \
--language-code en \
--text-list "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com."
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"Entities": [
{
"Score": 0.9985517859458923,
"Type": "PERSON",
"Text": "Jane",
"BeginOffset": 5,
"EndOffset": 9
},
{
"Score": 0.9767839312553406,
"Type": "ORGANIZATION",
"Text": "AnyCompany Financial Services, LLC",
"BeginOffset": 16,
"EndOffset": 50
},
{
"Score": 0.9856694936752319,
"Type": "OTHER",
"Text": "1111-XXXX-1111-XXXX",
"BeginOffset": 71,
"EndOffset": 90
},
{
"Score": 0.9652159810066223,
"Type": "QUANTITY",
"Text": ".53",
"BeginOffset": 116,
"EndOffset": 119
},
{
"Score": 0.9986667037010193,
"Type": "DATE",
"Text": "July 31st",
"BeginOffset": 135,
"EndOffset": 144
}
]
},
{
"Index": 1,
"Entities": [
{
"Score": 0.720084547996521,
"Type": "ORGANIZATION",
"Text": "Sunshine Spa",
"BeginOffset": 33,
"EndOffset": 45
},
{
"Score": 0.9865870475769043,
"Type": "LOCATION",
"Text": "123 Main St",
"BeginOffset": 47,
"EndOffset": 58
},
{
"Score": 0.5895616412162781,
"Type": "LOCATION",
"Text": "Anywhere",
"BeginOffset": 60,
"EndOffset": 68
},
{
"Score": 0.6809214353561401,
"Type": "PERSON",
"Text": "Alice",
"BeginOffset": 75,
"EndOffset": 80
},
{
"Score": 0.9979087114334106,
"Type": "OTHER",
"Text": "AnySpa@example.com",
"BeginOffset": 84,
"EndOffset": 99
}
]
}
],
"ErrorList": []
}
```
For more information, see [Entities](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-entities.html) in *AWS CLI Command Reference*.
### `batch-detect-key-phrases`
The following code example shows how to use `batch-detect-key-phrases`.
**AWS CLI**
**To detect key phrases of multiple text inputs**
The following `batch-detect-key-phrases` example analyzes multiple input texts and returns the key noun phrases of each. The pre-trained model's confidence score for each prediction is also output.
```
aws comprehend batch-detect-key-phrases \
--language-code en \
--text-list "Hello Zhang Wei, I am John, writing to you about the trip for next Saturday." "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com."
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"KeyPhrases": [
{
"Score": 0.99700927734375,
"Text": "Zhang Wei",
"BeginOffset": 6,
"EndOffset": 15
},
{
"Score": 0.9929308891296387,
"Text": "John",
"BeginOffset": 22,
"EndOffset": 26
},
{
"Score": 0.9997230172157288,
"Text": "the trip",
"BeginOffset": 49,
"EndOffset": 57
},
{
"Score": 0.9999470114707947,
"Text": "next Saturday",
"BeginOffset": 62,
"EndOffset": 75
}
]
},
{
"Index": 1,
"KeyPhrases": [
{
"Score": 0.8358274102210999,
"Text": "Dear Jane",
"BeginOffset": 0,
"EndOffset": 9
},
{
"Score": 0.989359974861145,
"Text": "Your AnyCompany Financial Services",
"BeginOffset": 11,
"EndOffset": 45
},
{
"Score": 0.8812323808670044,
"Text": "LLC credit card account 1111-XXXX-1111-XXXX",
"BeginOffset": 47,
"EndOffset": 90
},
{
"Score": 0.9999381899833679,
"Text": "a minimum payment",
"BeginOffset": 95,
"EndOffset": 112
},
{
"Score": 0.9997439980506897,
"Text": ".53",
"BeginOffset": 116,
"EndOffset": 119
},
{
"Score": 0.996875524520874,
"Text": "July 31st",
"BeginOffset": 135,
"EndOffset": 144
}
]
},
{
"Index": 2,
"KeyPhrases": [
{
"Score": 0.9990295767784119,
"Text": "customer feedback",
"BeginOffset": 12,
"EndOffset": 29
},
{
"Score": 0.9994127750396729,
"Text": "Sunshine Spa",
"BeginOffset": 33,
"EndOffset": 45
},
{
"Score": 0.9892991185188293,
"Text": "123 Main St",
"BeginOffset": 47,
"EndOffset": 58
},
{
"Score": 0.9969810843467712,
"Text": "Alice",
"BeginOffset": 75,
"EndOffset": 80
},
{
"Score": 0.9703696370124817,
"Text": "AnySpa@example.com",
"BeginOffset": 84,
"EndOffset": 99
}
]
}
],
"ErrorList": []
}
```
For more information, see [Key Phrases](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-key-phrases.html) in *AWS CLI Command Reference*.
### `batch-detect-sentiment`
The following code example shows how to use `batch-detect-sentiment`.
**AWS CLI**
**To detect the prevailing sentiment of multiple input texts**
The following `batch-detect-sentiment` example analyzes multiple input texts and returns the prevailing sentiment (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`, of each one).
```
aws comprehend batch-detect-sentiment \
--text-list "That movie was very boring, I can't believe it was over four hours long." "It is a beautiful day for hiking today." "My meal was okay, I'm excited to try other restaurants." \
--language-code en
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"Sentiment": "NEGATIVE",
"SentimentScore": {
"Positive": 0.00011316669406369328,
"Negative": 0.9995445609092712,
"Neutral": 0.00014722718333359808,
"Mixed": 0.00019498742767609656
}
},
{
"Index": 1,
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 0.9981263279914856,
"Negative": 0.00015240783977787942,
"Neutral": 0.0013876151060685515,
"Mixed": 0.00033366199932061136
}
},
{
"Index": 2,
"Sentiment": "MIXED",
"SentimentScore": {
"Positive": 0.15930435061454773,
"Negative": 0.11471917480230331,
"Neutral": 0.26897063851356506,
"Mixed": 0.45700588822364807
}
}
],
"ErrorList": []
}
```
For more information, see [Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-sentiment.html) in *AWS CLI Command Reference*.
### `batch-detect-syntax`
The following code example shows how to use `batch-detect-syntax`.
**AWS CLI**
**To inspect the syntax and parts of speech of words in multiple input texts**
The following `batch-detect-syntax` example analyzes the syntax of multiple input texts and returns the different parts of speech. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend batch-detect-syntax \
--text-list "It is a beautiful day." "Can you please pass the salt?" "Please pay the bill before the 31st." \
--language-code en
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"SyntaxTokens": [
{
"TokenId": 1,
"Text": "It",
"BeginOffset": 0,
"EndOffset": 2,
"PartOfSpeech": {
"Tag": "PRON",
"Score": 0.9999740719795227
}
},
{
"TokenId": 2,
"Text": "is",
"BeginOffset": 3,
"EndOffset": 5,
"PartOfSpeech": {
"Tag": "VERB",
"Score": 0.999937117099762
}
},
{
"TokenId": 3,
"Text": "a",
"BeginOffset": 6,
"EndOffset": 7,
"PartOfSpeech": {
"Tag": "DET",
"Score": 0.9999926686286926
}
},
{
"TokenId": 4,
"Text": "beautiful",
"BeginOffset": 8,
"EndOffset": 17,
"PartOfSpeech": {
"Tag": "ADJ",
"Score": 0.9987891912460327
}
},
{
"TokenId": 5,
"Text": "day",
"BeginOffset": 18,
"EndOffset": 21,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9999778866767883
}
},
{
"TokenId": 6,
"Text": ".",
"BeginOffset": 21,
"EndOffset": 22,
"PartOfSpeech": {
"Tag": "PUNCT",
"Score": 0.9999974966049194
}
}
]
},
{
"Index": 1,
"SyntaxTokens": [
{
"TokenId": 1,
"Text": "Can",
"BeginOffset": 0,
"EndOffset": 3,
"PartOfSpeech": {
"Tag": "AUX",
"Score": 0.9999770522117615
}
},
{
"TokenId": 2,
"Text": "you",
"BeginOffset": 4,
"EndOffset": 7,
"PartOfSpeech": {
"Tag": "PRON",
"Score": 0.9999986886978149
}
},
{
"TokenId": 3,
"Text": "please",
"BeginOffset": 8,
"EndOffset": 14,
"PartOfSpeech": {
"Tag": "INTJ",
"Score": 0.9681622385978699
}
},
{
"TokenId": 4,
"Text": "pass",
"BeginOffset": 15,
"EndOffset": 19,
"PartOfSpeech": {
"Tag": "VERB",
"Score": 0.9999874830245972
}
},
{
"TokenId": 5,
"Text": "the",
"BeginOffset": 20,
"EndOffset": 23,
"PartOfSpeech": {
"Tag": "DET",
"Score": 0.9999827146530151
}
},
{
"TokenId": 6,
"Text": "salt",
"BeginOffset": 24,
"EndOffset": 28,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9995040893554688
}
},
{
"TokenId": 7,
"Text": "?",
"BeginOffset": 28,
"EndOffset": 29,
"PartOfSpeech": {
"Tag": "PUNCT",
"Score": 0.999998152256012
}
}
]
},
{
"Index": 2,
"SyntaxTokens": [
{
"TokenId": 1,
"Text": "Please",
"BeginOffset": 0,
"EndOffset": 6,
"PartOfSpeech": {
"Tag": "INTJ",
"Score": 0.9997857809066772
}
},
{
"TokenId": 2,
"Text": "pay",
"BeginOffset": 7,
"EndOffset": 10,
"PartOfSpeech": {
"Tag": "VERB",
"Score": 0.9999252557754517
}
},
{
"TokenId": 3,
"Text": "the",
"BeginOffset": 11,
"EndOffset": 14,
"PartOfSpeech": {
"Tag": "DET",
"Score": 0.9999842643737793
}
},
{
"TokenId": 4,
"Text": "bill",
"BeginOffset": 15,
"EndOffset": 19,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9999588131904602
}
},
{
"TokenId": 5,
"Text": "before",
"BeginOffset": 20,
"EndOffset": 26,
"PartOfSpeech": {
"Tag": "ADP",
"Score": 0.9958304762840271
}
},
{
"TokenId": 6,
"Text": "the",
"BeginOffset": 27,
"EndOffset": 30,
"PartOfSpeech": {
"Tag": "DET",
"Score": 0.9999947547912598
}
},
{
"TokenId": 7,
"Text": "31st",
"BeginOffset": 31,
"EndOffset": 35,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9924124479293823
}
},
{
"TokenId": 8,
"Text": ".",
"BeginOffset": 35,
"EndOffset": 36,
"PartOfSpeech": {
"Tag": "PUNCT",
"Score": 0.9999955892562866
}
}
]
}
],
"ErrorList": []
}
```
For more information, see [Syntax Analysis](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-syntax.html) in *AWS CLI Command Reference*.
### `batch-detect-targeted-sentiment`
The following code example shows how to use `batch-detect-targeted-sentiment`.
**AWS CLI**
**To detect the sentiment and each named entity for multiple input texts**
The following `batch-detect-targeted-sentiment` example analyzes multiple input texts and returns the named entities along with the prevailing sentiment attached to each entity. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend batch-detect-targeted-sentiment \
--language-code en \
--text-list "That movie was really boring, the original was way more entertaining" "The trail is extra beautiful today." "My meal was just okay."
```
Output:
```
{
"ResultList": [
{
"Index": 0,
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9999009966850281,
"GroupScore": 1.0,
"Text": "movie",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "NEGATIVE",
"SentimentScore": {
"Positive": 0.13887299597263336,
"Negative": 0.8057460188865662,
"Neutral": 0.05525200068950653,
"Mixed": 0.00012799999967683107
}
},
"BeginOffset": 5,
"EndOffset": 10
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9921110272407532,
"GroupScore": 1.0,
"Text": "original",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 0.9999989867210388,
"Negative": 9.999999974752427e-07,
"Neutral": 0.0,
"Mixed": 0.0
}
},
"BeginOffset": 34,
"EndOffset": 42
}
]
}
]
},
{
"Index": 1,
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.7545599937438965,
"GroupScore": 1.0,
"Text": "trail",
"Type": "OTHER",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 1.0,
"Negative": 0.0,
"Neutral": 0.0,
"Mixed": 0.0
}
},
"BeginOffset": 4,
"EndOffset": 9
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9999960064888,
"GroupScore": 1.0,
"Text": "today",
"Type": "DATE",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Positive": 9.000000318337698e-06,
"Negative": 1.9999999949504854e-06,
"Neutral": 0.9999859929084778,
"Mixed": 3.999999989900971e-06
}
},
"BeginOffset": 29,
"EndOffset": 34
}
]
}
]
},
{
"Index": 2,
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9999880194664001,
"GroupScore": 1.0,
"Text": "My",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Positive": 0.0,
"Negative": 0.0,
"Neutral": 1.0,
"Mixed": 0.0
}
},
"BeginOffset": 0,
"EndOffset": 2
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9995260238647461,
"GroupScore": 1.0,
"Text": "meal",
"Type": "OTHER",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Positive": 0.04695599898695946,
"Negative": 0.003226999891921878,
"Neutral": 0.6091709733009338,
"Mixed": 0.34064599871635437
}
},
"BeginOffset": 3,
"EndOffset": 7
}
]
}
]
}
],
"ErrorList": []
}
```
For more information, see [Targeted Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [BatchDetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-targeted-sentiment.html) in *AWS CLI Command Reference*.
### `classify-document`
The following code example shows how to use `classify-document`.
**AWS CLI**
**To classify document with model-specific endpoint**
The following `classify-document` example classifies a document with an endpoint of a custom model. The model in this example was trained on a dataset containing sms messages labeled as spam or non-spam, or, "ham".
```
aws comprehend classify-document \
--endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint \
--text "CONGRATULATIONS! TXT 1235550100 to win $5000"
```
Output:
```
{
"Classes": [
{
"Name": "spam",
"Score": 0.9998599290847778
},
{
"Name": "ham",
"Score": 0.00014001205272506922
}
]
}
```
For more information, see [Custom Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ClassifyDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/classify-document.html) in *AWS CLI Command Reference*.
### `contains-pii-entities`
The following code example shows how to use `contains-pii-entities`.
**AWS CLI**
**To analyze the input text for the presence of PII information**
The following `contains-pii-entities` example analyzes the input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
```
aws comprehend contains-pii-entities \
--language-code en \
--text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card
account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings,
we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000.
Customer feedback for Sunshine Spa, 100 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"Labels": [
{
"Name": "NAME",
"Score": 1.0
},
{
"Name": "EMAIL",
"Score": 1.0
},
{
"Name": "BANK_ACCOUNT_NUMBER",
"Score": 0.9995794296264648
},
{
"Name": "BANK_ROUTING",
"Score": 0.9173126816749573
},
{
"Name": "CREDIT_DEBIT_NUMBER",
"Score": 1.0
}
}
```
For more information, see [Personally Identifiable Information (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ContainsPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/contains-pii-entities.html) in *AWS CLI Command Reference*.
### `create-dataset`
The following code example shows how to use `create-dataset`.
**AWS CLI**
**To create a flywheel dataset**
The following `create-dataset` example creates a dataset for a flywheel. This dataset will be used as additional training data as specified by the `--dataset-type` tag.
```
aws comprehend create-dataset \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity \
--dataset-name example-dataset \
--dataset-type "TRAIN" \
--input-data-config file://inputConfig.json
```
Contents of `file://inputConfig.json`:
```
{
"DataFormat": "COMPREHEND_CSV",
"DocumentClassifierInputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/training-data.csv"
}
}
```
Output:
```
{
"DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset"
}
```
For more information, see [Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in *Amazon Comprehend Developer Guide*.
+ For API details, see [CreateDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-dataset.html) in *AWS CLI Command Reference*.
### `create-document-classifier`
The following code example shows how to use `create-document-classifier`.
**AWS CLI**
**To create a document classifier to categorize documents**
The following `create-document-classifier` example begins the training process for a document classifier model. The training data file, `training.csv`, is located at the `--input-data-config` tag. `training.csv` is a two column document where the labels, or, classifications are provided in the first column and the documents are provided in the second column.
```
aws comprehend create-document-classifier \
--document-classifier-name example-classifier \
--data-access-arn arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--language-code en
```
Output:
```
{
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier"
}
```
For more information, see [Custom Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [CreateDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-document-classifier.html) in *AWS CLI Command Reference*.
### `create-endpoint`
The following code example shows how to use `create-endpoint`.
**AWS CLI**
**To create an endpoint for a custom model**
The following `create-endpoint` example creates an endpoint for synchronous inference for a previously trained custom model.
```
aws comprehend create-endpoint \
--endpoint-name example-classifier-endpoint-1 \
--model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier \
--desired-inference-units 1
```
Output:
```
{
"EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1"
}
```
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-endpoint.html) in *AWS CLI Command Reference*.
### `create-entity-recognizer`
The following code example shows how to use `create-entity-recognizer`.
**AWS CLI**
**To create a custom entity recognizer**
The following `create-entity-recognizer` example begins the training process for a custom entity recognizer model. This example uses a CSV file containing training documents, `raw_text.csv`, and a CSV entity list, `entity_list.csv` to train the model. `entity-list.csv` contains the following columns: text and type.
```
aws comprehend create-entity-recognizer \
--recognizer-name example-entity-recognizer
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--input-data-config "EntityTypes=[{Type=DEVICE}],Documents={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/raw_text.csv},EntityList={S3Uri=s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv}"
--language-code en
```
Output:
```
{
"EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:example-entity-recognizer/entityrecognizer1"
}
```
For more information, see [Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [CreateEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-entity-recognizer.html) in *AWS CLI Command Reference*.
### `create-flywheel`
The following code example shows how to use `create-flywheel`.
**AWS CLI**
**To create a flywheel**
The following `create-flywheel` example creates a flywheel to orchestrate the ongoing training of either a document classification or entity recognition model. The flywheel in this example is created to manage an existing trained model specified by the `--active-model-arn` tag. When the flywheel is created, a data lake is created at the `--input-data-lake` tag.
```
aws comprehend create-flywheel \
--flywheel-name example-flywheel \
--active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1 \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--data-lake-s3-uri "s3://amzn-s3-demo-bucket"
```
Output:
```
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel"
}
```
For more information, see [Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in *Amazon Comprehend Developer Guide*.
+ For API details, see [CreateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-flywheel.html) in *AWS CLI Command Reference*.
### `delete-document-classifier`
The following code example shows how to use `delete-document-classifier`.
**AWS CLI**
**To delete a custom document classifier**
The following `delete-document-classifier` example deletes a custom document classifier model.
```
aws comprehend delete-document-classifier \
--document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1
```
This command produces no output.
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DeleteDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-document-classifier.html) in *AWS CLI Command Reference*.
### `delete-endpoint`
The following code example shows how to use `delete-endpoint`.
**AWS CLI**
**To delete an endpoint for a custom model**
The following `delete-endpoint` example deletes a model-specific endpoint. All endpoints must be deleted in order for the model to be deleted.
```
aws comprehend delete-endpoint \
--endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1
```
This command produces no output.
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-endpoint.html) in *AWS CLI Command Reference*.
### `delete-entity-recognizer`
The following code example shows how to use `delete-entity-recognizer`.
**AWS CLI**
**To delete a custom entity recognizer model**
The following `delete-entity-recognizer` example deletes a custom entity recognizer model.
```
aws comprehend delete-entity-recognizer \
--entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/example-entity-recognizer-1
```
This command produces no output.
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DeleteEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-entity-recognizer.html) in *AWS CLI Command Reference*.
### `delete-flywheel`
The following code example shows how to use `delete-flywheel`.
**AWS CLI**
**To delete a flywheel**
The following `delete-flywheel` example deletes a flywheel. The data lake or the model associated with the flywheel is not deleted.
```
aws comprehend delete-flywheel \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1
```
This command produces no output.
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DeleteFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-flywheel.html) in *AWS CLI Command Reference*.
### `delete-resource-policy`
The following code example shows how to use `delete-resource-policy`.
**AWS CLI**
**To delete a resource-based policy**
The following `delete-resource-policy` example deletes a resource-based policy from an Amazon Comprehend resource.
```
aws comprehend delete-resource-policy \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1/version/1
```
This command produces no output.
For more information, see [Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DeleteResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-resource-policy.html) in *AWS CLI Command Reference*.
### `describe-dataset`
The following code example shows how to use `describe-dataset`.
**AWS CLI**
**To describe a flywheel dataset**
The following `describe-dataset` example gets the properties of a flywheel dataset.
```
aws comprehend describe-dataset \
--dataset-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset
```
Output:
```
{
"DatasetProperties": {
"DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset",
"DatasetName": "example-dataset",
"DatasetType": "TRAIN",
"DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/12345678A123456Z/datasets/example-dataset/20230616T203710Z/",
"Status": "CREATING",
"CreationTime": "2023-06-16T20:37:10.400000+00:00"
}
}
```
For more information, see [Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dataset.html) in *AWS CLI Command Reference*.
### `describe-document-classification-job`
The following code example shows how to use `describe-document-classification-job`.
**AWS CLI**
**To describe a document classification job**
The following `describe-document-classification-job` example gets the properties of an asynchronous document classification job.
```
aws comprehend describe-document-classification-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"DocumentClassificationJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "exampleclassificationjob",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-14T17:09:51.788000+00:00",
"EndTime": "2023-06-14T17:15:58.582000+00:00",
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/1",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/jobdata/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-CLN-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole"
}
}
```
For more information, see [Custom Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classification-job.html) in *AWS CLI Command Reference*.
### `describe-document-classifier`
The following code example shows how to use `describe-document-classifier`.
**AWS CLI**
**To describe a document classifier**
The following `describe-document-classifier` example gets the properties of a custom document classifier model.
```
aws comprehend describe-document-classifier \
--document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1
```
Output:
```
{
"DocumentClassifierProperties": {
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1",
"LanguageCode": "en",
"Status": "TRAINED",
"SubmitTime": "2023-06-13T19:04:15.735000+00:00",
"EndTime": "2023-06-13T19:42:31.752000+00:00",
"TrainingStartTime": "2023-06-13T19:08:20.114000+00:00",
"TrainingEndTime": "2023-06-13T19:41:35.080000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata"
},
"OutputDataConfig": {},
"ClassifierMetadata": {
"NumberOfLabels": 3,
"NumberOfTrainedDocuments": 5016,
"NumberOfTestDocuments": 557,
"EvaluationMetrics": {
"Accuracy": 0.9856,
"Precision": 0.9919,
"Recall": 0.9459,
"F1Score": 0.9673,
"MicroPrecision": 0.9856,
"MicroRecall": 0.9856,
"MicroF1Score": 0.9856,
"HammingLoss": 0.0144
}
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"Mode": "MULTI_CLASS"
}
}
```
For more information, see [Creating and managing custom models](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classifier.html) in *AWS CLI Command Reference*.
### `describe-dominant-language-detection-job`
The following code example shows how to use `describe-dominant-language-detection-job`.
**AWS CLI**
**To describe a dominant language detection detection job.**
The following `describe-dominant-language-detection-job` example gets the properties of an asynchronous dominant language detection job.
```
aws comprehend describe-dominant-language-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"DominantLanguageDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "languageanalysis1",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T18:10:38.037000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dominant-language-detection-job.html) in *AWS CLI Command Reference*.
### `describe-endpoint`
The following code example shows how to use `describe-endpoint`.
**AWS CLI**
**To describe a specific endpoint**
The following `describe-endpoint` example gets the properties of a model-specific endpoint.
```
aws comprehend describe-endpoint \
--endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint
```
Output:
```
{
"EndpointProperties": {
"EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint,
"Status": "IN_SERVICE",
"ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1",
"DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1",
"DesiredInferenceUnits": 1,
"CurrentInferenceUnits": 1,
"CreationTime": "2023-06-13T20:32:54.526000+00:00",
"LastModifiedTime": "2023-06-13T20:32:54.526000+00:00"
}
}
```
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-endpoint.html) in *AWS CLI Command Reference*.
### `describe-entities-detection-job`
The following code example shows how to use `describe-entities-detection-job`.
**AWS CLI**
**To describe an entities detection job**
The following `describe-entities-detection-job` example gets the properties of an asynchronous entities detection job.
```
aws comprehend describe-entities-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"EntitiesDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "example-entity-detector",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-08T21:30:15.323000+00:00",
"EndTime": "2023-06-08T21:40:23.509000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entities-detection-job.html) in *AWS CLI Command Reference*.
### `describe-entity-recognizer`
The following code example shows how to use `describe-entity-recognizer`.
**AWS CLI**
**To describe an entity recognizer**
The following `describe-entity-recognizer` example gets the properties of a custom entity recognizer model.
```
aws comprehend describe-entity-recognizer \
entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1
```
Output:
```
{
"EntityRecognizerProperties": {
"EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1",
"LanguageCode": "en",
"Status": "TRAINED",
"SubmitTime": "2023-06-14T20:44:59.631000+00:00",
"EndTime": "2023-06-14T20:59:19.532000+00:00",
"TrainingStartTime": "2023-06-14T20:48:52.811000+00:00",
"TrainingEndTime": "2023-06-14T20:58:11.473000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"EntityTypes": [
{
"Type": "BUSINESS"
}
],
"Documents": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"EntityList": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv"
}
},
"RecognizerMetadata": {
"NumberOfTrainedDocuments": 1814,
"NumberOfTestDocuments": 486,
"EvaluationMetrics": {
"Precision": 100.0,
"Recall": 100.0,
"F1Score": 100.0
},
"EntityTypes": [
{
"Type": "BUSINESS",
"EvaluationMetrics": {
"Precision": 100.0,
"Recall": 100.0,
"F1Score": 100.0
},
"NumberOfTrainMentions": 1520
}
]
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"VersionName": "1"
}
}
```
For more information, see [Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entity-recognizer.html) in *AWS CLI Command Reference*.
### `describe-events-detection-job`
The following code example shows how to use `describe-events-detection-job`.
**AWS CLI**
**To describe an events detection job.**
The following `describe-events-detection-job` example gets the properties of an asynchronous events detection job.
```
aws comprehend describe-events-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"EventsDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "events_job_1",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-12T18:45:56.054000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/EventsData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-EVENTS-123456abcdeb0e11022f22a11EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"TargetEventTypes": [
"BANKRUPTCY",
"EMPLOYMENT",
"CORPORATE_ACQUISITION",
"CORPORATE_MERGER",
"INVESTMENT_GENERAL"
]
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-events-detection-job.html) in *AWS CLI Command Reference*.
### `describe-flywheel-iteration`
The following code example shows how to use `describe-flywheel-iteration`.
**AWS CLI**
**To describe a flywheel iteration**
The following `describe-flywheel-iteration` example gets the properties of a flywheel iteration.
```
aws comprehend describe-flywheel-iteration \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel \
--flywheel-iteration-id 20232222AEXAMPLE
```
Output:
```
{
"FlywheelIterationProperties": {
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity",
"FlywheelIterationId": "20232222AEXAMPLE",
"CreationTime": "2023-06-16T21:10:26.385000+00:00",
"EndTime": "2023-06-16T23:33:16.827000+00:00",
"Status": "COMPLETED",
"Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.",
"EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1",
"EvaluatedModelMetrics": {
"AverageF1Score": 0.7742663922375772,
"AveragePrecision": 0.8287636394041166,
"AverageRecall": 0.7427084833645399,
"AverageAccuracy": 0.8795394154118689
},
"TrainedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/Comprehend-Generated-v1-bb52d585",
"TrainedModelMetrics": {
"AverageF1Score": 0.9767700253081214,
"AveragePrecision": 0.9767700253081214,
"AverageRecall": 0.9767700253081214,
"AverageAccuracy": 0.9858281665190434
},
"EvaluationManifestS3Prefix": "s3://amzn-s3-demo-destination-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/evaluation/20230616T211026Z/"
}
}
```
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel-iteration.html) in *AWS CLI Command Reference*.
### `describe-flywheel`
The following code example shows how to use `describe-flywheel`.
**AWS CLI**
**To describe a flywheel**
The following `describe-flywheel` example gets the properties of a flywheel. In this example, the model associated with the flywheel is a custom classifier model that is trained to classify documents as either spam or nonspam, or, "ham".
```
aws comprehend describe-flywheel \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel
```
Output:
```
{
"FlywheelProperties": {
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel",
"ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-model/version/1",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"TaskConfig": {
"LanguageCode": "en",
"DocumentClassificationConfig": {
"Mode": "MULTI_CLASS",
"Labels": [
"ham",
"spam"
]
}
},
"DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230616T200543Z/",
"DataSecurityConfig": {},
"Status": "ACTIVE",
"ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": "2023-06-16T20:05:43.242000+00:00",
"LastModifiedTime": "2023-06-16T20:21:43.567000+00:00"
}
}
```
For more information, see [Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel.html) in *AWS CLI Command Reference*.
### `describe-key-phrases-detection-job`
The following code example shows how to use `describe-key-phrases-detection-job`.
**AWS CLI**
**To describe a key phrases detection job**
The following `describe-key-phrases-detection-job` example gets the properties of an asynchronous key phrases detection job.
```
aws comprehend describe-key-phrases-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"KeyPhrasesDetectionJobProperties": {
"JobId": "69aa080c00fc68934a6a98f10EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/69aa080c00fc68934a6a98f10EXAMPLE",
"JobName": "example-key-phrases-detection-job",
"JobStatus": "COMPLETED",
"SubmitTime": 1686606439.177,
"EndTime": 1686606806.157,
"InputDataConfig": {
"S3Uri": "s3://dereksbucket1001/EventsData/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://dereksbucket1002/testfolder/111122223333-KP-69aa080c00fc68934a6a98f10EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testrole"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-key-phrases-detection-job.html) in *AWS CLI Command Reference*.
### `describe-pii-entities-detection-job`
The following code example shows how to use `describe-pii-entities-detection-job`.
**AWS CLI**
**To describe a PII entities detection job**
The following `describe-pii-entities-detection-job` example gets the properties of an asynchronous pii entities detection job.
```
aws comprehend describe-pii-entities-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"PiiEntitiesDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "example-pii-entities-job",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-08T21:30:15.323000+00:00",
"EndTime": "2023-06-08T21:40:23.509000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/thefolder/111122223333-NER-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::12345678012:role/service-role/AmazonComprehendServiceRole-example-role"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribePiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-pii-entities-detection-job.html) in *AWS CLI Command Reference*.
### `describe-resource-policy`
The following code example shows how to use `describe-resource-policy`.
**AWS CLI**
**To describe a resource policy attached to a model**
The following `describe-resource-policy` example gets the properties of a resource-based policy attached to a model.
```
aws comprehend describe-resource-policy \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1
```
Output:
```
{
"ResourcePolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::444455556666:root\"},\"Action\":\"comprehend:ImportModel\",\"Resource\":\"*\"}]}",
"CreationTime": "2023-06-19T18:44:26.028000+00:00",
"LastModifiedTime": "2023-06-19T18:53:02.002000+00:00",
"PolicyRevisionId": "baa675d069d07afaa2aa3106ae280f61"
}
```
For more information, see [Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-resource-policy.html) in *AWS CLI Command Reference*.
### `describe-sentiment-detection-job`
The following code example shows how to use `describe-sentiment-detection-job`.
**AWS CLI**
**To describe a sentiment detection job**
The following `describe-sentiment-detection-job` example gets the properties of an asynchronous sentiment detection job.
```
aws comprehend describe-sentiment-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"SentimentDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "movie_review_analysis",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T23:16:15.956000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `describe-targeted-sentiment-detection-job`
The following code example shows how to use `describe-targeted-sentiment-detection-job`.
**AWS CLI**
**To describe a targeted sentiment detection job**
The following `describe-targeted-sentiment-detection-job` example gets the properties of an asynchronous targeted sentiment detection job.
```
aws comprehend describe-targeted-sentiment-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"TargetedSentimentDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "movie_review_analysis",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T23:16:15.956000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-targeted-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `describe-topics-detection-job`
The following code example shows how to use `describe-topics-detection-job`.
**AWS CLI**
**To describe a topics detection job**
The following `describe-topics-detection-job` example gets the properties of an asynchronous topics detection job.
```
aws comprehend describe-topics-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"TopicsDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "example_topics_detection",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T18:44:43.414000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"NumberOfTopics": 10,
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-examplerole"
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DescribeTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-topics-detection-job.html) in *AWS CLI Command Reference*.
### `detect-dominant-language`
The following code example shows how to use `detect-dominant-language`.
**AWS CLI**
**To detect the dominant language of input text**
The following `detect-dominant-language` analyzes the input text and identifies the dominant language. The pre-trained model's confidence score is also output.
```
aws comprehend detect-dominant-language \
--text "It is a beautiful day in Seattle."
```
Output:
```
{
"Languages": [
{
"LanguageCode": "en",
"Score": 0.9877256155014038
}
]
}
```
For more information, see [Dominant Language](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-dominant-language.html) in *AWS CLI Command Reference*.
### `detect-entities`
The following code example shows how to use `detect-entities`.
**AWS CLI**
**To detect named entities in input text**
The following `detect-entities` example analyzes the input text and returns the named entities. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend detect-entities \
--language-code en \
--text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \
account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \
we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \
Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"Entities": [
{
"Score": 0.9994556307792664,
"Type": "PERSON",
"Text": "Zhang Wei",
"BeginOffset": 6,
"EndOffset": 15
},
{
"Score": 0.9981022477149963,
"Type": "PERSON",
"Text": "John",
"BeginOffset": 22,
"EndOffset": 26
},
{
"Score": 0.9986887574195862,
"Type": "ORGANIZATION",
"Text": "AnyCompany Financial Services, LLC",
"BeginOffset": 33,
"EndOffset": 67
},
{
"Score": 0.9959119558334351,
"Type": "OTHER",
"Text": "1111-XXXX-1111-XXXX",
"BeginOffset": 88,
"EndOffset": 107
},
{
"Score": 0.9708039164543152,
"Type": "QUANTITY",
"Text": ".53",
"BeginOffset": 133,
"EndOffset": 136
},
{
"Score": 0.9987268447875977,
"Type": "DATE",
"Text": "July 31st",
"BeginOffset": 152,
"EndOffset": 161
},
{
"Score": 0.9858865737915039,
"Type": "OTHER",
"Text": "XXXXXX1111",
"BeginOffset": 271,
"EndOffset": 281
},
{
"Score": 0.9700471758842468,
"Type": "OTHER",
"Text": "XXXXX0000",
"BeginOffset": 306,
"EndOffset": 315
},
{
"Score": 0.9591118693351746,
"Type": "ORGANIZATION",
"Text": "Sunshine Spa",
"BeginOffset": 340,
"EndOffset": 352
},
{
"Score": 0.9797496795654297,
"Type": "LOCATION",
"Text": "123 Main St",
"BeginOffset": 354,
"EndOffset": 365
},
{
"Score": 0.994929313659668,
"Type": "PERSON",
"Text": "Alice",
"BeginOffset": 394,
"EndOffset": 399
},
{
"Score": 0.9949769377708435,
"Type": "OTHER",
"Text": "AnySpa@example.com",
"BeginOffset": 403,
"EndOffset": 418
}
]
}
```
For more information, see [Entities](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-entities.html) in *AWS CLI Command Reference*.
### `detect-key-phrases`
The following code example shows how to use `detect-key-phrases`.
**AWS CLI**
**To detect key phrases in input text**
The following `detect-key-phrases` example analyzes the input text and identifies the key noun phrases. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend detect-key-phrases \
--language-code en \
--text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \
account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \
we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \
Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"KeyPhrases": [
{
"Score": 0.8996376395225525,
"Text": "Zhang Wei",
"BeginOffset": 6,
"EndOffset": 15
},
{
"Score": 0.9992469549179077,
"Text": "John",
"BeginOffset": 22,
"EndOffset": 26
},
{
"Score": 0.988385021686554,
"Text": "Your AnyCompany Financial Services",
"BeginOffset": 28,
"EndOffset": 62
},
{
"Score": 0.8740853071212769,
"Text": "LLC credit card account 1111-XXXX-1111-XXXX",
"BeginOffset": 64,
"EndOffset": 107
},
{
"Score": 0.9999437928199768,
"Text": "a minimum payment",
"BeginOffset": 112,
"EndOffset": 129
},
{
"Score": 0.9998900890350342,
"Text": ".53",
"BeginOffset": 133,
"EndOffset": 136
},
{
"Score": 0.9979453086853027,
"Text": "July 31st",
"BeginOffset": 152,
"EndOffset": 161
},
{
"Score": 0.9983011484146118,
"Text": "your autopay settings",
"BeginOffset": 172,
"EndOffset": 193
},
{
"Score": 0.9996572136878967,
"Text": "your payment",
"BeginOffset": 211,
"EndOffset": 223
},
{
"Score": 0.9995037317276001,
"Text": "the due date",
"BeginOffset": 227,
"EndOffset": 239
},
{
"Score": 0.9702621698379517,
"Text": "your bank account number XXXXXX1111",
"BeginOffset": 245,
"EndOffset": 280
},
{
"Score": 0.9179925918579102,
"Text": "the routing number XXXXX0000.Customer feedback",
"BeginOffset": 286,
"EndOffset": 332
},
{
"Score": 0.9978160858154297,
"Text": "Sunshine Spa",
"BeginOffset": 337,
"EndOffset": 349
},
{
"Score": 0.9706913232803345,
"Text": "123 Main St",
"BeginOffset": 351,
"EndOffset": 362
},
{
"Score": 0.9941995143890381,
"Text": "comments",
"BeginOffset": 379,
"EndOffset": 387
},
{
"Score": 0.9759287238121033,
"Text": "Alice",
"BeginOffset": 391,
"EndOffset": 396
},
{
"Score": 0.8376792669296265,
"Text": "AnySpa@example.com",
"BeginOffset": 400,
"EndOffset": 415
}
]
}
```
For more information, see [Key Phrases](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-key-phrases.html) in *AWS CLI Command Reference*.
### `detect-pii-entities`
The following code example shows how to use `detect-pii-entities`.
**AWS CLI**
**To detect pii entities in input text**
The following `detect-pii-entities` example analyzes the input text and identifies entities that contain personally identifiable information (PII). The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend detect-pii-entities \
--language-code en \
--text "Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card \
account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st. Based on your autopay settings, \
we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. \
Customer feedback for Sunshine Spa, 123 Main St, Anywhere. Send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"Entities": [
{
"Score": 0.9998322129249573,
"Type": "NAME",
"BeginOffset": 6,
"EndOffset": 15
},
{
"Score": 0.9998878240585327,
"Type": "NAME",
"BeginOffset": 22,
"EndOffset": 26
},
{
"Score": 0.9994089603424072,
"Type": "CREDIT_DEBIT_NUMBER",
"BeginOffset": 88,
"EndOffset": 107
},
{
"Score": 0.9999760985374451,
"Type": "DATE_TIME",
"BeginOffset": 152,
"EndOffset": 161
},
{
"Score": 0.9999449253082275,
"Type": "BANK_ACCOUNT_NUMBER",
"BeginOffset": 271,
"EndOffset": 281
},
{
"Score": 0.9999847412109375,
"Type": "BANK_ROUTING",
"BeginOffset": 306,
"EndOffset": 315
},
{
"Score": 0.999925434589386,
"Type": "ADDRESS",
"BeginOffset": 354,
"EndOffset": 365
},
{
"Score": 0.9989161491394043,
"Type": "NAME",
"BeginOffset": 394,
"EndOffset": 399
},
{
"Score": 0.9994171857833862,
"Type": "EMAIL",
"BeginOffset": 403,
"EndOffset": 418
}
]
}
```
For more information, see [Personally Identifiable Information (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-pii-entities.html) in *AWS CLI Command Reference*.
### `detect-sentiment`
The following code example shows how to use `detect-sentiment`.
**AWS CLI**
**To detect the sentiment of an input text**
The following `detect-sentiment` example analyzes the input text and returns an inference of the prevailing sentiment (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
```
aws comprehend detect-sentiment \
--language-code en \
--text "It is a beautiful day in Seattle"
```
Output:
```
{
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 0.9976957440376282,
"Negative": 9.653854067437351e-05,
"Neutral": 0.002169104292988777,
"Mixed": 3.857641786453314e-05
}
}
```
For more information, see [Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html) in the *Amazon Comprehend Developer Guide*
+ For API details, see [DetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-sentiment.html) in *AWS CLI Command Reference*.
### `detect-syntax`
The following code example shows how to use `detect-syntax`.
**AWS CLI**
**To detect the parts of speech in an input text**
The following `detect-syntax` example analyzes the syntax of the input text and returns the different parts of speech. The pre-trained model's confidence score is also output for each prediction.
```
aws comprehend detect-syntax \
--language-code en \
--text "It is a beautiful day in Seattle."
```
Output:
```
{
"SyntaxTokens": [
{
"TokenId": 1,
"Text": "It",
"BeginOffset": 0,
"EndOffset": 2,
"PartOfSpeech": {
"Tag": "PRON",
"Score": 0.9999740719795227
}
},
{
"TokenId": 2,
"Text": "is",
"BeginOffset": 3,
"EndOffset": 5,
"PartOfSpeech": {
"Tag": "VERB",
"Score": 0.999901294708252
}
},
{
"TokenId": 3,
"Text": "a",
"BeginOffset": 6,
"EndOffset": 7,
"PartOfSpeech": {
"Tag": "DET",
"Score": 0.9999938607215881
}
},
{
"TokenId": 4,
"Text": "beautiful",
"BeginOffset": 8,
"EndOffset": 17,
"PartOfSpeech": {
"Tag": "ADJ",
"Score": 0.9987351894378662
}
},
{
"TokenId": 5,
"Text": "day",
"BeginOffset": 18,
"EndOffset": 21,
"PartOfSpeech": {
"Tag": "NOUN",
"Score": 0.9999796748161316
}
},
{
"TokenId": 6,
"Text": "in",
"BeginOffset": 22,
"EndOffset": 24,
"PartOfSpeech": {
"Tag": "ADP",
"Score": 0.9998047947883606
}
},
{
"TokenId": 7,
"Text": "Seattle",
"BeginOffset": 25,
"EndOffset": 32,
"PartOfSpeech": {
"Tag": "PROPN",
"Score": 0.9940530061721802
}
}
]
}
```
For more information, see [Syntax Analysis](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-syntax.html) in *AWS CLI Command Reference*.
### `detect-targeted-sentiment`
The following code example shows how to use `detect-targeted-sentiment`.
**AWS CLI**
**To detect the targeted sentiment of named entities in an input text**
The following `detect-targeted-sentiment` example analyzes the input text and returns the named entities in addition to the targeted sentiment associated with each entity. The pre-trained models confidence score for each prediction is also output.
```
aws comprehend detect-targeted-sentiment \
--language-code en \
--text "I do not enjoy January because it is too cold but August is the perfect temperature"
```
Output:
```
{
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9999979734420776,
"GroupScore": 1.0,
"Text": "I",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Positive": 0.0,
"Negative": 0.0,
"Neutral": 1.0,
"Mixed": 0.0
}
},
"BeginOffset": 0,
"EndOffset": 1
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9638869762420654,
"GroupScore": 1.0,
"Text": "January",
"Type": "DATE",
"MentionSentiment": {
"Sentiment": "NEGATIVE",
"SentimentScore": {
"Positive": 0.0031610000878572464,
"Negative": 0.9967250227928162,
"Neutral": 0.00011100000119768083,
"Mixed": 1.9999999949504854e-06
}
},
"BeginOffset": 15,
"EndOffset": 22
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
{
"Score": 0.9664419889450073,
"GroupScore": 1.0,
"Text": "August",
"Type": "DATE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 0.9999549984931946,
"Negative": 3.999999989900971e-06,
"Neutral": 4.099999932805076e-05,
"Mixed": 0.0
}
},
"BeginOffset": 50,
"EndOffset": 56
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"Score": 0.9803199768066406,
"GroupScore": 1.0,
"Text": "temperature",
"Type": "ATTRIBUTE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Positive": 1.0,
"Negative": 0.0,
"Neutral": 0.0,
"Mixed": 0.0
}
},
"BeginOffset": 77,
"EndOffset": 88
}
]
}
]
}
```
For more information, see [Targeted Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [DetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-targeted-sentiment.html) in *AWS CLI Command Reference*.
### `import-model`
The following code example shows how to use `import-model`.
**AWS CLI**
**To import a model**
The following `import-model` example imports a model from a different AWS account. The document classifier model in account `444455556666` has a resource-based policy allowing account `111122223333` to import the model.
```
aws comprehend import-model \
--source-model-arn arn:aws:comprehend:us-west-2:444455556666:document-classifier/example-classifier
```
Output:
```
{
"ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier"
}
```
For more information, see [Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ImportModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/import-model.html) in *AWS CLI Command Reference*.
### `list-datasets`
The following code example shows how to use `list-datasets`.
**AWS CLI**
**To list all flywheel datasets**
The following `list-datasets` example lists all datasets associated with a flywheel.
```
aws comprehend list-datasets \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity
```
Output:
```
{
"DatasetPropertiesList": [
{
"DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-1",
"DatasetName": "example-dataset-1",
"DatasetType": "TRAIN",
"DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-1/20230616T203710Z/",
"Status": "CREATING",
"CreationTime": "2023-06-16T20:37:10.400000+00:00"
},
{
"DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset-2",
"DatasetName": "example-dataset-2",
"DatasetType": "TRAIN",
"DatasetS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/datasets/example-dataset-2/20230616T200607Z/",
"Description": "TRAIN Dataset created by Flywheel creation.",
"Status": "COMPLETED",
"NumberOfDocuments": 5572,
"CreationTime": "2023-06-16T20:06:07.722000+00:00"
}
]
}
```
For more information, see [Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in *Amazon Comprehend Developer Guide*.
+ For API details, see [ListDatasets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-datasets.html) in *AWS CLI Command Reference*.
### `list-document-classification-jobs`
The following code example shows how to use `list-document-classification-jobs`.
**AWS CLI**
**To list of all document classification jobs**
The following `list-document-classification-jobs` example lists all document classification jobs.
```
aws comprehend list-document-classification-jobs
```
Output:
```
{
"DocumentClassificationJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "exampleclassificationjob",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-14T17:09:51.788000+00:00",
"EndTime": "2023-06-14T17:15:58.582000+00:00",
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/jobdata/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-e758dd56b824aa717ceab551f11749fb/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a1EXAMPLE2",
"JobArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classification-job/123456abcdeb0e11022f22a1EXAMPLE2",
"JobName": "exampleclassificationjob2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-14T17:22:39.829000+00:00",
"EndTime": "2023-06-14T17:28:46.107000+00:00",
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:1234567890101:document-classifier/mymodel/version/12",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/jobdata/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/1234567890101-CLN-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::1234567890101:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Custom Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListDocumentClassificationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classification-jobs.html) in *AWS CLI Command Reference*.
### `list-document-classifier-summaries`
The following code example shows how to use `list-document-classifier-summaries`.
**AWS CLI**
**To list the summaries of all created document classifiers**
The following `list-document-classifier-summaries` example lists all created document classifier summaries.
```
aws comprehend list-document-classifier-summaries
```
Output:
```
{
"DocumentClassifierSummariesList": [
{
"DocumentClassifierName": "example-classifier-1",
"NumberOfVersions": 1,
"LatestVersionCreatedAt": "2023-06-13T22:07:59.825000+00:00",
"LatestVersionName": "1",
"LatestVersionStatus": "TRAINED"
},
{
"DocumentClassifierName": "example-classifier-2",
"NumberOfVersions": 2,
"LatestVersionCreatedAt": "2023-06-13T21:54:59.589000+00:00",
"LatestVersionName": "2",
"LatestVersionStatus": "TRAINED"
}
]
}
```
For more information, see [Creating and managing custom models](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListDocumentClassifierSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifier-summaries.html) in *AWS CLI Command Reference*.
### `list-document-classifiers`
The following code example shows how to use `list-document-classifiers`.
**AWS CLI**
**To list of all document classifiers**
The following `list-document-classifiers` example lists all trained and in-training document classifier models.
```
aws comprehend list-document-classifiers
```
Output:
```
{
"DocumentClassifierPropertiesList": [
{
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1",
"LanguageCode": "en",
"Status": "TRAINED",
"SubmitTime": "2023-06-13T19:04:15.735000+00:00",
"EndTime": "2023-06-13T19:42:31.752000+00:00",
"TrainingStartTime": "2023-06-13T19:08:20.114000+00:00",
"TrainingEndTime": "2023-06-13T19:41:35.080000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata"
},
"OutputDataConfig": {},
"ClassifierMetadata": {
"NumberOfLabels": 3,
"NumberOfTrainedDocuments": 5016,
"NumberOfTestDocuments": 557,
"EvaluationMetrics": {
"Accuracy": 0.9856,
"Precision": 0.9919,
"Recall": 0.9459,
"F1Score": 0.9673,
"MicroPrecision": 0.9856,
"MicroRecall": 0.9856,
"MicroF1Score": 0.9856,
"HammingLoss": 0.0144
}
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle",
"Mode": "MULTI_CLASS"
},
{
"DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2",
"LanguageCode": "en",
"Status": "TRAINING",
"SubmitTime": "2023-06-13T21:20:28.690000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata"
},
"OutputDataConfig": {},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-testorle",
"Mode": "MULTI_CLASS"
}
]
}
```
For more information, see [Creating and managing custom models](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListDocumentClassifiers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifiers.html) in *AWS CLI Command Reference*.
### `list-dominant-language-detection-jobs`
The following code example shows how to use `list-dominant-language-detection-jobs`.
**AWS CLI**
**To list all dominant language detection jobs**
The following `list-dominant-language-detection-jobs` example lists all in-progress and completed asynchronous dominant language detection jobs.
```
aws comprehend list-dominant-language-detection-jobs
```
Output:
```
{
"DominantLanguageDetectionJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "languageanalysis1",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T18:10:38.037000+00:00",
"EndTime": "2023-06-09T18:18:45.498000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "languageanalysis2",
"JobStatus": "STOPPED",
"SubmitTime": "2023-06-09T18:16:33.690000+00:00",
"EndTime": "2023-06-09T18:24:40.608000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-LANGUAGE-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListDominantLanguageDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-dominant-language-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-endpoints`
The following code example shows how to use `list-endpoints`.
**AWS CLI**
**To list of all endpoints**
The following `list-endpoints` example lists all active model-specific endpoints.
```
aws comprehend list-endpoints
```
Output:
```
{
"EndpointPropertiesList": [
{
"EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint",
"Status": "IN_SERVICE",
"ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1",
"DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier1",
"DesiredInferenceUnits": 1,
"CurrentInferenceUnits": 1,
"CreationTime": "2023-06-13T20:32:54.526000+00:00",
"LastModifiedTime": "2023-06-13T20:32:54.526000+00:00"
},
{
"EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/ExampleClassifierEndpoint2",
"Status": "IN_SERVICE",
"ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2",
"DesiredModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2",
"DesiredInferenceUnits": 1,
"CurrentInferenceUnits": 1,
"CreationTime": "2023-06-13T20:32:54.526000+00:00",
"LastModifiedTime": "2023-06-13T20:32:54.526000+00:00"
}
]
}
```
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-endpoints.html) in *AWS CLI Command Reference*.
### `list-entities-detection-jobs`
The following code example shows how to use `list-entities-detection-jobs`.
**AWS CLI**
**To list all entities detection jobs**
The following `list-entities-detection-jobs` example lists all asynchronous entities detection jobs.
```
aws comprehend list-entities-detection-jobs
```
Output:
```
{
"EntitiesDetectionJobPropertiesList": [
{
"JobId": "468af39c28ab45b83eb0c4ab9EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/468af39c28ab45b83eb0c4ab9EXAMPLE",
"JobName": "example-entities-detection",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-08T20:57:46.476000+00:00",
"EndTime": "2023-06-08T21:05:53.718000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-468af39c28ab45b83eb0c4ab9EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "809691caeaab0e71406f80a28EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/809691caeaab0e71406f80a28EXAMPLE",
"JobName": "example-entities-detection-2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-08T21:30:15.323000+00:00",
"EndTime": "2023-06-08T21:40:23.509000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-809691caeaab0e71406f80a28EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "e00597c36b448b91d70dea165EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/e00597c36b448b91d70dea165EXAMPLE",
"JobName": "example-entities-detection-3",
"JobStatus": "STOPPED",
"SubmitTime": "2023-06-08T22:19:28.528000+00:00",
"EndTime": "2023-06-08T22:27:33.991000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-NER-e00597c36b448b91d70dea165EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Entities](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entities-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-entity-recognizer-summaries`
The following code example shows how to use `list-entity-recognizer-summaries`.
**AWS CLI**
**To list of summaries for all created entity recognizers**
The following `list-entity-recognizer-summaries` example lists all entity recognizer summaries.
```
aws comprehend list-entity-recognizer-summaries
```
Output:
```
{
"EntityRecognizerSummariesList": [
{
"RecognizerName": "entity-recognizer-3",
"NumberOfVersions": 2,
"LatestVersionCreatedAt": "2023-06-15T23:15:07.621000+00:00",
"LatestVersionName": "2",
"LatestVersionStatus": "STOP_REQUESTED"
},
{
"RecognizerName": "entity-recognizer-2",
"NumberOfVersions": 1,
"LatestVersionCreatedAt": "2023-06-14T22:55:27.805000+00:00",
"LatestVersionName": "2"
"LatestVersionStatus": "TRAINED"
},
{
"RecognizerName": "entity-recognizer-1",
"NumberOfVersions": 1,
"LatestVersionCreatedAt": "2023-06-14T20:44:59.631000+00:00",
"LatestVersionName": "1",
"LatestVersionStatus": "TRAINED"
}
]
}
```
For more information, see [Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListEntityRecognizerSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizer-summaries.html) in *AWS CLI Command Reference*.
### `list-entity-recognizers`
The following code example shows how to use `list-entity-recognizers`.
**AWS CLI**
**To list of all custom entity recognizers**
The following `list-entity-recognizers` example lists all created custom entity recognizers.
```
aws comprehend list-entity-recognizers
```
Output:
```
{
"EntityRecognizerPropertiesList": [
{
"EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/EntityRecognizer/version/1",
"LanguageCode": "en",
"Status": "TRAINED",
"SubmitTime": "2023-06-14T20:44:59.631000+00:00",
"EndTime": "2023-06-14T20:59:19.532000+00:00",
"TrainingStartTime": "2023-06-14T20:48:52.811000+00:00",
"TrainingEndTime": "2023-06-14T20:58:11.473000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"EntityTypes": [
{
"Type": "BUSINESS"
}
],
"Documents": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"EntityList": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv"
}
},
"RecognizerMetadata": {
"NumberOfTrainedDocuments": 1814,
"NumberOfTestDocuments": 486,
"EvaluationMetrics": {
"Precision": 100.0,
"Recall": 100.0,
"F1Score": 100.0
},
"EntityTypes": [
{
"Type": "BUSINESS",
"EvaluationMetrics": {
"Precision": 100.0,
"Recall": 100.0,
"F1Score": 100.0
},
"NumberOfTrainMentions": 1520
}
]
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole",
"VersionName": "1"
},
{
"EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer3",
"LanguageCode": "en",
"Status": "TRAINED",
"SubmitTime": "2023-06-14T22:57:51.056000+00:00",
"EndTime": "2023-06-14T23:14:13.894000+00:00",
"TrainingStartTime": "2023-06-14T23:01:33.984000+00:00",
"TrainingEndTime": "2023-06-14T23:13:02.984000+00:00",
"InputDataConfig": {
"DataFormat": "COMPREHEND_CSV",
"EntityTypes": [
{
"Type": "DEVICE"
}
],
"Documents": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/raw_txt.csv",
"InputFormat": "ONE_DOC_PER_LINE"
},
"EntityList": {
"S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity_list.csv"
}
},
"RecognizerMetadata": {
"NumberOfTrainedDocuments": 4616,
"NumberOfTestDocuments": 3489,
"EvaluationMetrics": {
"Precision": 98.54227405247813,
"Recall": 100.0,
"F1Score": 99.26578560939794
},
"EntityTypes": [
{
"Type": "DEVICE",
"EvaluationMetrics": {
"Precision": 98.54227405247813,
"Recall": 100.0,
"F1Score": 99.26578560939794
},
"NumberOfTrainMentions": 2764
}
]
},
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole"
}
]
}
```
For more information, see [Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListEntityRecognizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizers.html) in *AWS CLI Command Reference*.
### `list-events-detection-jobs`
The following code example shows how to use `list-events-detection-jobs`.
**AWS CLI**
**To list all events detection jobs**
The following `list-events-detection-jobs` example lists all asynchronous events detection jobs.
```
aws comprehend list-events-detection-jobs
```
Output:
```
{
"EventsDetectionJobPropertiesList": [
{
"JobId": "aa9593f9203e84f3ef032ce18EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/aa9593f9203e84f3ef032ce18EXAMPLE",
"JobName": "events_job_1",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-12T19:14:57.751000+00:00",
"EndTime": "2023-06-12T19:21:04.962000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-aa9593f9203e84f3ef032ce18EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role",
"TargetEventTypes": [
"BANKRUPTCY",
"EMPLOYMENT",
"CORPORATE_ACQUISITION",
"CORPORATE_MERGER",
"INVESTMENT_GENERAL"
]
},
{
"JobId": "4a990a2f7e82adfca6e171135EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:1111222233333:events-detection-job/4a990a2f7e82adfca6e171135EXAMPLE",
"JobName": "events_job_2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-12T19:55:43.702000+00:00",
"EndTime": "2023-06-12T20:03:49.893000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/EventsData/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/1111222233333-EVENTS-4a990a2f7e82adfca6e171135EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::1111222233333:role/service-role/AmazonComprehendServiceRole-example-role",
"TargetEventTypes": [
"BANKRUPTCY",
"EMPLOYMENT",
"CORPORATE_ACQUISITION",
"CORPORATE_MERGER",
"INVESTMENT_GENERAL"
]
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListEventsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-events-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-flywheel-iteration-history`
The following code example shows how to use `list-flywheel-iteration-history`.
**AWS CLI**
**To list all flywheel iteration history**
The following `list-flywheel-iteration-history` example lists all iterations of a flywheel.
```
aws comprehend list-flywheel-iteration-history
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel
```
Output:
```
{
"FlywheelIterationPropertiesList": [
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel",
"FlywheelIterationId": "20230619TEXAMPLE",
"CreationTime": "2023-06-19T04:00:32.594000+00:00",
"EndTime": "2023-06-19T04:00:49.248000+00:00",
"Status": "COMPLETED",
"Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.",
"EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1",
"EvaluatedModelMetrics": {
"AverageF1Score": 0.7742663922375772,
"AverageF1Score": 0.9876464664646313,
"AveragePrecision": 0.9800000253081214,
"AverageRecall": 0.9445600253081214,
"AverageAccuracy": 0.9997281665190434
},
"EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel/schemaVersion=1/20230619TEXAMPLE/evaluation/20230619TEXAMPLE/"
},
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2",
"FlywheelIterationId": "20230616TEXAMPLE",
"CreationTime": "2023-06-16T21:10:26.385000+00:00",
"EndTime": "2023-06-16T23:33:16.827000+00:00",
"Status": "COMPLETED",
"Message": "FULL_ITERATION: Flywheel iteration performed all functions successfully.",
"EvaluatedModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/spamvshamclassify/version/1",
"EvaluatedModelMetrics": {
"AverageF1Score": 0.7742663922375772,
"AverageF1Score": 0.9767700253081214,
"AveragePrecision": 0.9767700253081214,
"AverageRecall": 0.9767700253081214,
"AverageAccuracy": 0.9858281665190434
},
"EvaluationManifestS3Prefix": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20230616TEXAMPLE/evaluation/20230616TEXAMPLE/"
}
]
}
```
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListFlywheelIterationHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheel-iteration-history.html) in *AWS CLI Command Reference*.
### `list-flywheels`
The following code example shows how to use `list-flywheels`.
**AWS CLI**
**To list all flywheels**
The following `list-flywheels` example lists all created flywheels.
```
aws comprehend list-flywheels
```
Output:
```
{
"FlywheelSummaryList": [
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1",
"ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier/version/1",
"DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-1/schemaVersion=1/20230616T200543Z/",
"Status": "ACTIVE",
"ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": "2023-06-16T20:05:43.242000+00:00",
"LastModifiedTime": "2023-06-19T04:00:43.027000+00:00",
"LatestFlywheelIteration": "20230619T040032Z"
},
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-2",
"ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/exampleclassifier2/version/1",
"DataLakeS3Uri": "s3://amzn-s3-demo-bucket/example-flywheel-2/schemaVersion=1/20220616T200543Z/",
"Status": "ACTIVE",
"ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": "2022-06-16T20:05:43.242000+00:00",
"LastModifiedTime": "2022-06-19T04:00:43.027000+00:00",
"LatestFlywheelIteration": "20220619T040032Z"
}
]
}
```
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListFlywheels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheels.html) in *AWS CLI Command Reference*.
### `list-key-phrases-detection-jobs`
The following code example shows how to use `list-key-phrases-detection-jobs`.
**AWS CLI**
**To list all key phrases detection jobs**
The following `list-key-phrases-detection-jobs` example lists all in-progress and completed asynchronous key phrases detection jobs.
```
aws comprehend list-key-phrases-detection-jobs
```
Output:
```
{
"KeyPhrasesDetectionJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "keyphrasesanalysis1",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-08T22:31:43.767000+00:00",
"EndTime": "2023-06-08T22:39:52.565000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a33EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a33EXAMPLE",
"JobName": "keyphrasesanalysis2",
"JobStatus": "STOPPED",
"SubmitTime": "2023-06-08T22:57:52.154000+00:00",
"EndTime": "2023-06-08T23:05:48.385000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a33EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a44EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a44EXAMPLE",
"JobName": "keyphrasesanalysis3",
"JobStatus": "FAILED",
"Message": "NO_READ_ACCESS_TO_INPUT: The provided data access role does not have proper access to the input data.",
"SubmitTime": "2023-06-09T16:47:04.029000+00:00",
"EndTime": "2023-06-09T16:47:18.413000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-KP-123456abcdeb0e11022f22a44EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListKeyPhrasesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-key-phrases-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-pii-entities-detection-jobs`
The following code example shows how to use `list-pii-entities-detection-jobs`.
**AWS CLI**
**To list all pii entities detection jobs**
The following `list-pii-entities-detection-jobs` example lists all in-progress and completed asynchronous pii detection jobs.
```
aws comprehend list-pii-entities-detection-jobs
```
Output:
```
{
"PiiEntitiesDetectionJobPropertiesList": [
{
"JobId": "6f9db0c42d0c810e814670ee4EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/6f9db0c42d0c810e814670ee4EXAMPLE",
"JobName": "example-pii-detection-job",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T21:02:46.241000+00:00",
"EndTime": "2023-06-09T21:12:52.602000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-source-bucket/111122223333-PII-6f9db0c42d0c810e814670ee4EXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"Mode": "ONLY_OFFSETS"
},
{
"JobId": "d927562638cfa739331a99b3cEXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/d927562638cfa739331a99b3cEXAMPLE",
"JobName": "example-pii-detection-job-2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T21:20:58.211000+00:00",
"EndTime": "2023-06-09T21:31:06.027000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/AsyncBatchJobs/",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-PII-d927562638cfa739331a99b3cEXAMPLE/output/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"Mode": "ONLY_OFFSETS"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListPiiEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-pii-entities-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-sentiment-detection-jobs`
The following code example shows how to use `list-sentiment-detection-jobs`.
**AWS CLI**
**To list all sentiment detection jobs**
The following `list-sentiment-detection-jobs` example lists all in-progress and completed asynchronous sentiment detection jobs.
```
aws comprehend list-sentiment-detection-jobs
```
Output:
```
{
"SentimentDetectionJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "example-sentiment-detection-job",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T22:42:20.545000+00:00",
"EndTime": "2023-06-09T22:52:27.416000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a1EXAMPLE2",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2",
"JobName": "example-sentiment-detection-job-2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T23:16:15.956000+00:00",
"EndTime": "2023-06-09T23:26:00.168000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData2",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-sentiment-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list tags for resource**
The following `list-tags-for-resource` example lists the tags for an Amazon Comprehend resource.
```
aws comprehend list-tags-for-resource \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1
```
Output:
```
{
"ResourceArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1",
"Tags": [
{
"Key": "Department",
"Value": "Finance"
},
{
"Key": "location",
"Value": "Seattle"
}
]
}
```
For more information, see [Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `list-targeted-sentiment-detection-jobs`
The following code example shows how to use `list-targeted-sentiment-detection-jobs`.
**AWS CLI**
**To list all targeted sentiment detection jobs**
The following `list-targeted-sentiment-detection-jobs` example lists all in-progress and completed asynchronous targeted sentiment detection jobs.
```
aws comprehend list-targeted-sentiment-detection-jobs
```
Output:
```
{
"TargetedSentimentDetectionJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "example-targeted-sentiment-detection-job",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T22:42:20.545000+00:00",
"EndTime": "2023-06-09T22:52:27.416000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole"
},
{
"JobId": "123456abcdeb0e11022f22a1EXAMPLE2",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a1EXAMPLE2",
"JobName": "example-targeted-sentiment-detection-job-2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T23:16:15.956000+00:00",
"EndTime": "2023-06-09T23:26:00.168000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData2",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListTargetedSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-targeted-sentiment-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-topics-detection-jobs`
The following code example shows how to use `list-topics-detection-jobs`.
**AWS CLI**
**To list all topic detection jobs**
The following `list-topics-detection-jobs` example lists all in-progress and completed asynchronous topics detection jobs.
```
aws comprehend list-topics-detection-jobs
```
Output:
```
{
"TopicsDetectionJobPropertiesList": [
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName" "topic-analysis-1"
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T18:40:35.384000+00:00",
"EndTime": "2023-06-09T18:46:41.936000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"NumberOfTopics": 10,
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a1EXAMPLE2",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE2",
"JobName": "topic-analysis-2",
"JobStatus": "COMPLETED",
"SubmitTime": "2023-06-09T18:44:43.414000+00:00",
"EndTime": "2023-06-09T18:50:50.872000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE2/output/output.tar.gz"
},
"NumberOfTopics": 10,
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
},
{
"JobId": "123456abcdeb0e11022f22a1EXAMPLE3",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/123456abcdeb0e11022f22a1EXAMPLE3",
"JobName": "topic-analysis-2",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T18:50:56.737000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/thefolder/111122223333-TOPICS-123456abcdeb0e11022f22a1EXAMPLE3/output/output.tar.gz"
},
"NumberOfTopics": 10,
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role"
}
]
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [ListTopicsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-topics-detection-jobs.html) in *AWS CLI Command Reference*.
### `put-resource-policy`
The following code example shows how to use `put-resource-policy`.
**AWS CLI**
**To attach a resource-based policy**
The following `put-resource-policy` example attaches a resource-based policy to a model so that can be imported by another AWS account. The policy is attached to the model in account `111122223333` and allows account `444455556666` import the model.
```
aws comprehend put-resource-policy \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \
--resource-policy '{"Version":"2012-10-17", "Statement":[{"Effect":"Allow","Action":"comprehend:ImportModel","Resource":"*","Principal":{"AWS":["arn:aws:iam::444455556666:root"]}}]}'
```
Output:
```
{
"PolicyRevisionId": "aaa111d069d07afaa2aa3106aEXAMPLE"
}
```
For more information, see [Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [PutResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/put-resource-policy.html) in *AWS CLI Command Reference*.
### `start-document-classification-job`
The following code example shows how to use `start-document-classification-job`.
**AWS CLI**
**To start document classification job**
The following `start-document-classification-job` example starts a document classification job with a custom model on all of the files at the address specified by the `--input-data-config` tag. In this example, the input S3 bucket contains `SampleSMStext1.txt`, `SampleSMStext2.txt`, and `SampleSMStext3.txt`. The model was previously trained on document classifications of spam and non-spam, or, "ham", SMS messages. When the job is complete, `output.tar.gz` is put at the location specified by the `--output-data-config` tag. `output.tar.gz` contains `predictions.jsonl` which lists the classification of each document. The Json output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-document-classification-job \
--job-name exampleclassificationjob \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket-INPUT/jobdata/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/mymodel/version/12
```
Contents of `SampleSMStext1.txt`:
```
"CONGRATULATIONS! TXT 2155550100 to win $5000"
```
Contents of `SampleSMStext2.txt`:
```
"Hi, when do you want me to pick you up from practice?"
```
Contents of `SampleSMStext3.txt`:
```
"Plz send bank account # to 2155550100 to claim prize!!"
```
Output:
```
{
"JobId": "e758dd56b824aa717ceab551fEXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/e758dd56b824aa717ceab551fEXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `predictions.jsonl`:
```
{"File": "SampleSMSText1.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]}
{"File": "SampleSMStext2.txt", "Line": "0", "Classes": [{"Name": "ham", "Score": 0.9994}, {"Name": "spam", "Score": 0.0006}]}
{"File": "SampleSMSText3.txt", "Line": "0", "Classes": [{"Name": "spam", "Score": 0.9999}, {"Name": "ham", "Score": 0.0001}]}
```
For more information, see [Custom Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-document-classification-job.html) in *AWS CLI Command Reference*.
### `start-dominant-language-detection-job`
The following code example shows how to use `start-dominant-language-detection-job`.
**AWS CLI**
**To start an asynchronous language detection job**
The following `start-dominant-language-detection-job` example starts an asynchronous language detection job for all of the files located at the address specified by the `--input-data-config` tag. The S3 bucket in this example contains `Sampletext1.txt`. When the job is complete, the folder, `output`, is placed in the location specified by the `--output-data-config` tag. The folder contains `output.txt` which contains the dominant language of each of the text files as well as the pre-trained model's confidence score for each prediction.
```
aws comprehend start-dominant-language-detection-job \
--job-name example_language_analysis_job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
```
Contents of Sampletext1.txt:
```
"Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force."
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `output.txt`:
```
{"File": "Sampletext1.txt", "Languages": [{"LanguageCode": "en", "Score": 0.9913753867149353}], "Line": 0}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-dominant-language-detection-job.html) in *AWS CLI Command Reference*.
### `start-entities-detection-job`
The following code example shows how to use `start-entities-detection-job`.
**AWS CLI**
**Example 1: To start a standard entity detection job using the pre-trained model**
The following `start-entities-detection-job` example starts an asynchronous entities detection job for all files located at the address specified by the `--input-data-config` tag. The S3 bucket in this example contains `Sampletext1.txt`, `Sampletext2.txt`, and `Sampletext3.txt`. When the job is complete, the folder, `output`, is placed in the location specified by the `--output-data-config` tag. The folder contains `output.txt` which lists all of the named entities detected within each text file as well as the pre-trained model's confidence score for each prediction. The Json output is printed on one line per input file, but is formatted here for readability.
```
aws comprehend start-entities-detection-job \
--job-name entitiestest \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
```
Contents of `Sampletext1.txt`:
```
"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."
```
Contents of `Sampletext2.txt`:
```
"Dear Max, based on your autopay settings for your account example1.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "
```
Contents of `Sampletext3.txt`:
```
"Jane, please submit any customer feedback from this weekend to AnySpa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `output.txt` with line indents for readability:
```
{
"Entities": [
{
"BeginOffset": 6,
"EndOffset": 15,
"Score": 0.9994006636420306,
"Text": "Zhang Wei",
"Type": "PERSON"
},
{
"BeginOffset": 22,
"EndOffset": 26,
"Score": 0.9976647915128143,
"Text": "John",
"Type": "PERSON"
},
{
"BeginOffset": 33,
"EndOffset": 67,
"Score": 0.9984608700836206,
"Text": "AnyCompany Financial Services, LLC",
"Type": "ORGANIZATION"
},
{
"BeginOffset": 88,
"EndOffset": 107,
"Score": 0.9868521019555556,
"Text": "1111-XXXX-1111-XXXX",
"Type": "OTHER"
},
{
"BeginOffset": 133,
"EndOffset": 139,
"Score": 0.998242565709204,
"Text": "$24.53",
"Type": "QUANTITY"
},
{
"BeginOffset": 155,
"EndOffset": 164,
"Score": 0.9993039263159287,
"Text": "July 31st",
"Type": "DATE"
}
],
"File": "SampleText1.txt",
"Line": 0
}
{
"Entities": [
{
"BeginOffset": 5,
"EndOffset": 8,
"Score": 0.9866232147545232,
"Text": "Max",
"Type": "PERSON"
},
{
"BeginOffset": 156,
"EndOffset": 166,
"Score": 0.9797723450933329,
"Text": "XXXXXX1111",
"Type": "OTHER"
},
{
"BeginOffset": 191,
"EndOffset": 200,
"Score": 0.9247838572396843,
"Text": "XXXXX0000",
"Type": "OTHER"
}
],
"File": "SampleText2.txt",
"Line": 0
}
{
"Entities": [
{
"Score": 0.9990532994270325,
"Type": "PERSON",
"Text": "Jane",
"BeginOffset": 0,
"EndOffset": 4
},
{
"Score": 0.9519651532173157,
"Type": "DATE",
"Text": "this weekend",
"BeginOffset": 47,
"EndOffset": 59
},
{
"Score": 0.5566426515579224,
"Type": "ORGANIZATION",
"Text": "AnySpa",
"BeginOffset": 63,
"EndOffset": 69
},
{
"Score": 0.8059805631637573,
"Type": "LOCATION",
"Text": "123 Main St, Anywhere",
"BeginOffset": 71,
"EndOffset": 92
},
{
"Score": 0.998830258846283,
"Type": "PERSON",
"Text": "Alice",
"BeginOffset": 114,
"EndOffset": 119
},
{
"Score": 0.997818112373352,
"Type": "OTHER",
"Text": "AnySpa@example.com",
"BeginOffset": 123,
"EndOffset": 138
}
],
"File": "SampleText3.txt",
"Line": 0
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
**Example 2: To start a custom entity detection job**
The following `start-entities-detection-job` example starts an asynchronous custom entities detection job for all files located at the address specified by the `--input-data-config` tag. In this example, the S3 bucket in this example contains `SampleFeedback1.txt`, `SampleFeedback2.txt`, and `SampleFeedback3.txt`. The entity recognizer model was trained on customer support Feedbacks to recognize device names. When the job is complete, an the folder, `output`, is put at the location specified by the `--output-data-config` tag. The folder contains `output.txt`, which lists all of the named entities detected within each text file as well as the pre-trained model's confidence score for each prediction. The Json output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-entities-detection-job \
--job-name customentitiestest \
--entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/entityrecognizer" \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/jobdata/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-IOrole"
```
Contents of `SampleFeedback1.txt`:
```
"I've been on the AnyPhone app have had issues for 24 hours when trying to pay bill. Cannot make payment. Sigh. | Oh man! Lets get that app up and running. DM me, and we can get to work!"
```
Contents of `SampleFeedback2.txt`:
```
"Hi, I have a discrepancy with my new bill. Could we get it sorted out? A rep added stuff I didn't sign up for when I did my AnyPhone 10 upgrade. | We can absolutely get this sorted!"
```
Contents of `SampleFeedback3.txt`:
```
"Is the by 1 get 1 free AnySmartPhone promo still going on? | Hi Christian! It ended yesterday, send us a DM if you have any questions and we can take a look at your options!"
```
Output:
```
{
"JobId": "019ea9edac758806850fa8a79ff83021",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/019ea9edac758806850fa8a79ff83021",
"JobStatus": "SUBMITTED"
}
```
Contents of `output.txt` with line indents for readability:
```
{
"Entities": [
{
"BeginOffset": 17,
"EndOffset": 25,
"Score": 0.9999728210205924,
"Text": "AnyPhone",
"Type": "DEVICE"
}
],
"File": "SampleFeedback1.txt",
"Line": 0
}
{
"Entities": [
{
"BeginOffset": 123,
"EndOffset": 133,
"Score": 0.9999892116761524,
"Text": "AnyPhone 10",
"Type": "DEVICE"
}
],
"File": "SampleFeedback2.txt",
"Line": 0
}
{
"Entities": [
{
"BeginOffset": 23,
"EndOffset": 35,
"Score": 0.9999971389852362,
"Text": "AnySmartPhone",
"Type": "DEVICE"
}
],
"File": "SampleFeedback3.txt",
"Line": 0
}
```
For more information, see [Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-entities-detection-job.html) in *AWS CLI Command Reference*.
### `start-events-detection-job`
The following code example shows how to use `start-events-detection-job`.
**AWS CLI**
**To start an asynchronous events detection job**
The following `start-events-detection-job` example starts an asynchronous events detection job for all files located at the address specified by the `--input-data-config` tag. Possible target event types include `BANKRUPCTY`, `EMPLOYMENT`, `CORPORATE_ACQUISITION`, `INVESTMENT_GENERAL`, `CORPORATE_MERGER`, `IPO`, `RIGHTS_ISSUE`, `SECONDARY_OFFERING`, `SHELF_OFFERING`, `TENDER_OFFERING`, and `STOCK_SPLIT`. The S3 bucket in this example contains `SampleText1.txt`, `SampleText2.txt`, and `SampleText3.txt`. When the job is complete, the folder, `output`, is placed in the location specified by the `--output-data-config` tag. The folder contains `SampleText1.txt.out`, `SampleText2.txt.out`, and `SampleText3.txt.out`. The JSON output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-events-detection-job \
--job-name events-detection-1 \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/EventsData" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole \
--language-code en \
--target-event-types "BANKRUPTCY" "EMPLOYMENT" "CORPORATE_ACQUISITION" "CORPORATE_MERGER" "INVESTMENT_GENERAL"
```
Contents of `SampleText1.txt`:
```
"Company AnyCompany grew by increasing sales and through acquisitions. After purchasing competing firms in 2020, AnyBusiness, a part of the AnyBusinessGroup, gave Jane Does firm a going rate of one cent a gallon or forty-two cents a barrel."
```
Contents of `SampleText2.txt`:
```
"In 2021, AnyCompany officially purchased AnyBusiness for 100 billion dollars, surprising and exciting the shareholders."
```
Contents of `SampleText3.txt`:
```
"In 2022, AnyCompany stock crashed 50. Eventually later that year they filed for bankruptcy."
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `SampleText1.txt.out` with line indents for readability:
```
{
"Entities": [
{
"Mentions": [
{
"BeginOffset": 8,
"EndOffset": 18,
"Score": 0.99977,
"Text": "AnyCompany",
"Type": "ORGANIZATION",
"GroupScore": 1
},
{
"BeginOffset": 112,
"EndOffset": 123,
"Score": 0.999747,
"Text": "AnyBusiness",
"Type": "ORGANIZATION",
"GroupScore": 0.979826
},
{
"BeginOffset": 171,
"EndOffset": 175,
"Score": 0.999615,
"Text": "firm",
"Type": "ORGANIZATION",
"GroupScore": 0.871647
}
]
},
{
"Mentions": [
{
"BeginOffset": 97,
"EndOffset": 102,
"Score": 0.987687,
"Text": "firms",
"Type": "ORGANIZATION",
"GroupScore": 1
}
]
},
{
"Mentions": [
{
"BeginOffset": 103,
"EndOffset": 110,
"Score": 0.999458,
"Text": "in 2020",
"Type": "DATE",
"GroupScore": 1
}
]
},
{
"Mentions": [
{
"BeginOffset": 160,
"EndOffset": 168,
"Score": 0.999649,
"Text": "John Doe",
"Type": "PERSON",
"GroupScore": 1
}
]
}
],
"Events": [
{
"Type": "CORPORATE_ACQUISITION",
"Arguments": [
{
"EntityIndex": 0,
"Role": "INVESTOR",
"Score": 0.99977
}
],
"Triggers": [
{
"BeginOffset": 56,
"EndOffset": 68,
"Score": 0.999967,
"Text": "acquisitions",
"Type": "CORPORATE_ACQUISITION",
"GroupScore": 1
}
]
},
{
"Type": "CORPORATE_ACQUISITION",
"Arguments": [
{
"EntityIndex": 1,
"Role": "INVESTEE",
"Score": 0.987687
},
{
"EntityIndex": 2,
"Role": "DATE",
"Score": 0.999458
},
{
"EntityIndex": 3,
"Role": "INVESTOR",
"Score": 0.999649
}
],
"Triggers": [
{
"BeginOffset": 76,
"EndOffset": 86,
"Score": 0.999973,
"Text": "purchasing",
"Type": "CORPORATE_ACQUISITION",
"GroupScore": 1
}
]
}
],
"File": "SampleText1.txt",
"Line": 0
}
```
Contents of `SampleText2.txt.out`:
```
{
"Entities": [
{
"Mentions": [
{
"BeginOffset": 0,
"EndOffset": 7,
"Score": 0.999473,
"Text": "In 2021",
"Type": "DATE",
"GroupScore": 1
}
]
},
{
"Mentions": [
{
"BeginOffset": 9,
"EndOffset": 19,
"Score": 0.999636,
"Text": "AnyCompany",
"Type": "ORGANIZATION",
"GroupScore": 1
}
]
},
{
"Mentions": [
{
"BeginOffset": 45,
"EndOffset": 56,
"Score": 0.999712,
"Text": "AnyBusiness",
"Type": "ORGANIZATION",
"GroupScore": 1
}
]
},
{
"Mentions": [
{
"BeginOffset": 61,
"EndOffset": 80,
"Score": 0.998886,
"Text": "100 billion dollars",
"Type": "MONETARY_VALUE",
"GroupScore": 1
}
]
}
],
"Events": [
{
"Type": "CORPORATE_ACQUISITION",
"Arguments": [
{
"EntityIndex": 3,
"Role": "AMOUNT",
"Score": 0.998886
},
{
"EntityIndex": 2,
"Role": "INVESTEE",
"Score": 0.999712
},
{
"EntityIndex": 0,
"Role": "DATE",
"Score": 0.999473
},
{
"EntityIndex": 1,
"Role": "INVESTOR",
"Score": 0.999636
}
],
"Triggers": [
{
"BeginOffset": 31,
"EndOffset": 40,
"Score": 0.99995,
"Text": "purchased",
"Type": "CORPORATE_ACQUISITION",
"GroupScore": 1
}
]
}
],
"File": "SampleText2.txt",
"Line": 0
}
```
Contents of `SampleText3.txt.out`:
```
{
"Entities": [
{
"Mentions": [
{
"BeginOffset": 9,
"EndOffset": 19,
"Score": 0.999774,
"Text": "AnyCompany",
"Type": "ORGANIZATION",
"GroupScore": 1
},
{
"BeginOffset": 66,
"EndOffset": 70,
"Score": 0.995717,
"Text": "they",
"Type": "ORGANIZATION",
"GroupScore": 0.997626
}
]
},
{
"Mentions": [
{
"BeginOffset": 50,
"EndOffset": 65,
"Score": 0.999656,
"Text": "later that year",
"Type": "DATE",
"GroupScore": 1
}
]
}
],
"Events": [
{
"Type": "BANKRUPTCY",
"Arguments": [
{
"EntityIndex": 1,
"Role": "DATE",
"Score": 0.999656
},
{
"EntityIndex": 0,
"Role": "FILER",
"Score": 0.995717
}
],
"Triggers": [
{
"BeginOffset": 81,
"EndOffset": 91,
"Score": 0.999936,
"Text": "bankruptcy",
"Type": "BANKRUPTCY",
"GroupScore": 1
}
]
}
],
"File": "SampleText3.txt",
"Line": 0
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-events-detection-job.html) in *AWS CLI Command Reference*.
### `start-flywheel-iteration`
The following code example shows how to use `start-flywheel-iteration`.
**AWS CLI**
**To start a flywheel iteration**
The following `start-flywheel-iteration` example starts a flywheel iteration. This operation uses any new datasets in the flywheel to train a new model version.
```
aws comprehend start-flywheel-iteration \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel
```
Output:
```
{
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel",
"FlywheelIterationId": "12345123TEXAMPLE"
}
```
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-flywheel-iteration.html) in *AWS CLI Command Reference*.
### `start-key-phrases-detection-job`
The following code example shows how to use `start-key-phrases-detection-job`.
**AWS CLI**
**To start a key phrases detection job**
The following `start-key-phrases-detection-job` example starts an asynchronous key phrases detection job for all files located at the address specified by the `--input-data-config` tag. The S3 bucket in this example contains `Sampletext1.txt`, `Sampletext2.txt`, and `Sampletext3.txt`. When the job is completed, the folder, `output`, is placed in the location specified by the `--output-data-config` tag. The folder contains the file `output.txt` which contains all the key phrases detected within each text file and the pre-trained model's confidence score for each prediction. The Json output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-key-phrases-detection-job \
--job-name keyphrasesanalysistest1 \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role" \
--language-code en
```
Contents of `Sampletext1.txt`:
```
"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."
```
Contents of `Sampletext2.txt`:
```
"Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "
```
Contents of `Sampletext3.txt`:
```
"Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `output.txt` with line indents for readability:
```
{
"File": "SampleText1.txt",
"KeyPhrases": [
{
"BeginOffset": 6,
"EndOffset": 15,
"Score": 0.9748965572679326,
"Text": "Zhang Wei"
},
{
"BeginOffset": 22,
"EndOffset": 26,
"Score": 0.9997344722354619,
"Text": "John"
},
{
"BeginOffset": 28,
"EndOffset": 62,
"Score": 0.9843791074032948,
"Text": "Your AnyCompany Financial Services"
},
{
"BeginOffset": 64,
"EndOffset": 107,
"Score": 0.8976122401721824,
"Text": "LLC credit card account 1111-XXXX-1111-XXXX"
},
{
"BeginOffset": 112,
"EndOffset": 129,
"Score": 0.9999612982629748,
"Text": "a minimum payment"
},
{
"BeginOffset": 133,
"EndOffset": 139,
"Score": 0.99975728947036,
"Text": "$24.53"
},
{
"BeginOffset": 155,
"EndOffset": 164,
"Score": 0.9940866241449973,
"Text": "July 31st"
}
],
"Line": 0
}
{
"File": "SampleText2.txt",
"KeyPhrases": [
{
"BeginOffset": 0,
"EndOffset": 8,
"Score": 0.9974021100118472,
"Text": "Dear Max"
},
{
"BeginOffset": 19,
"EndOffset": 40,
"Score": 0.9961120519515884,
"Text": "your autopay settings"
},
{
"BeginOffset": 45,
"EndOffset": 78,
"Score": 0.9980620070116009,
"Text": "your account Internet.org account"
},
{
"BeginOffset": 97,
"EndOffset": 109,
"Score": 0.999919660140754,
"Text": "your payment"
},
{
"BeginOffset": 113,
"EndOffset": 125,
"Score": 0.9998370719754205,
"Text": "the due date"
},
{
"BeginOffset": 131,
"EndOffset": 166,
"Score": 0.9955068678502509,
"Text": "your bank account number XXXXXX1111"
},
{
"BeginOffset": 172,
"EndOffset": 200,
"Score": 0.8653433315829526,
"Text": "the routing number XXXXX0000"
}
],
"Line": 0
}
{
"File": "SampleText3.txt",
"KeyPhrases": [
{
"BeginOffset": 0,
"EndOffset": 4,
"Score": 0.9142947833681668,
"Text": "Jane"
},
{
"BeginOffset": 20,
"EndOffset": 41,
"Score": 0.9984325676596763,
"Text": "any customer feedback"
},
{
"BeginOffset": 47,
"EndOffset": 59,
"Score": 0.9998782448150636,
"Text": "this weekend"
},
{
"BeginOffset": 63,
"EndOffset": 75,
"Score": 0.99866741830757,
"Text": "Sunshine Spa"
},
{
"BeginOffset": 77,
"EndOffset": 88,
"Score": 0.9695803485466054,
"Text": "123 Main St"
},
{
"BeginOffset": 108,
"EndOffset": 116,
"Score": 0.9997065928550928,
"Text": "comments"
},
{
"BeginOffset": 120,
"EndOffset": 125,
"Score": 0.9993466833825161,
"Text": "Alice"
},
{
"BeginOffset": 129,
"EndOffset": 144,
"Score": 0.9654563612885667,
"Text": "AnySpa@example.com"
}
],
"Line": 0
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-key-phrases-detection-job.html) in *AWS CLI Command Reference*.
### `start-pii-entities-detection-job`
The following code example shows how to use `start-pii-entities-detection-job`.
**AWS CLI**
**To start an asynchronous PII detection job**
The following `start-pii-entities-detection-job` example starts an asynchronous personal identifiable information (PII) entities detection job for all files located at the address specified by the `--input-data-config` tag. The S3 bucket in this example contains `Sampletext1.txt`, `Sampletext2.txt`, and `Sampletext3.txt`. When the job is complete, the folder, `output`, is placed in the location specified by the `--output-data-config` tag. The folder contains `SampleText1.txt.out`, `SampleText2.txt.out`, and `SampleText3.txt.out` which list the named entities within each text file. The Json output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-pii-entities-detection-job \
--job-name entities_test \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en \
--mode ONLY_OFFSETS
```
Contents of `Sampletext1.txt`:
```
"Hello Zhang Wei, I am John. Your AnyCompany Financial Services, LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st."
```
Contents of `Sampletext2.txt`:
```
"Dear Max, based on your autopay settings for your account Internet.org account, we will withdraw your payment on the due date from your bank account number XXXXXX1111 with the routing number XXXXX0000. "
```
Contents of `Sampletext3.txt`:
```
"Jane, please submit any customer feedback from this weekend to Sunshine Spa, 123 Main St, Anywhere and send comments to Alice at AnySpa@example.com."
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
Contents of `SampleText1.txt.out` with line indents for readability:
```
{
"Entities": [
{
"BeginOffset": 6,
"EndOffset": 15,
"Type": "NAME",
"Score": 0.9998490510222595
},
{
"BeginOffset": 22,
"EndOffset": 26,
"Type": "NAME",
"Score": 0.9998937958019426
},
{
"BeginOffset": 88,
"EndOffset": 107,
"Type": "CREDIT_DEBIT_NUMBER",
"Score": 0.9554297245278491
},
{
"BeginOffset": 155,
"EndOffset": 164,
"Type": "DATE_TIME",
"Score": 0.9999720462925257
}
],
"File": "SampleText1.txt",
"Line": 0
}
```
Contents of `SampleText2.txt.out` with line indents for readability:
```
{
"Entities": [
{
"BeginOffset": 5,
"EndOffset": 8,
"Type": "NAME",
"Score": 0.9994390774924007
},
{
"BeginOffset": 58,
"EndOffset": 70,
"Type": "URL",
"Score": 0.9999958276922101
},
{
"BeginOffset": 156,
"EndOffset": 166,
"Type": "BANK_ACCOUNT_NUMBER",
"Score": 0.9999721058045592
},
{
"BeginOffset": 191,
"EndOffset": 200,
"Type": "BANK_ROUTING",
"Score": 0.9998968945989909
}
],
"File": "SampleText2.txt",
"Line": 0
}
```
Contents of `SampleText3.txt.out` with line indents for readability:
```
{
"Entities": [
{
"BeginOffset": 0,
"EndOffset": 4,
"Type": "NAME",
"Score": 0.999949934606805
},
{
"BeginOffset": 77,
"EndOffset": 88,
"Type": "ADDRESS",
"Score": 0.9999035300466904
},
{
"BeginOffset": 120,
"EndOffset": 125,
"Type": "NAME",
"Score": 0.9998203838716296
},
{
"BeginOffset": 129,
"EndOffset": 144,
"Type": "EMAIL",
"Score": 0.9998313473105228
}
],
"File": "SampleText3.txt",
"Line": 0
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-pii-entities-detection-job.html) in *AWS CLI Command Reference*.
### `start-sentiment-detection-job`
The following code example shows how to use `start-sentiment-detection-job`.
**AWS CLI**
**To start an asynchronous sentiment analysis job**
The following `start-sentiment-detection-job` example starts an asynchronous sentiment analysis detection job for all files located at the address specified by the `--input-data-config` tag. The S3 bucket folder in this example contains `SampleMovieReview1.txt`, `SampleMovieReview2.txt`, and `SampleMovieReview3.txt`. When the job is complete, the folder, `output`, is placed at the location specified by the `--output-data-config` tag. The folder contains the file, `output.txt`, which contains the prevailing sentiments for each text file and the pre-trained model's confidence score for each prediction. The Json output is printed on one line per file, but is formatted here for readability.
```
aws comprehend start-sentiment-detection-job \
--job-name example-sentiment-detection-job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role
```
Contents of `SampleMovieReview1.txt`:
```
"The film, AnyMovie2, is fairly predictable and just okay."
```
Contents of `SampleMovieReview2.txt`:
```
"AnyMovie2 is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie."
```
Contents of `SampleMovieReview3.txt`:
```
"Don't get fooled by the 'awards' for AnyMovie2. All parts of the film were poorly stolen from other modern directors."
```
Output:
```
{
"JobId": "0b5001e25f62ebb40631a9a1a7fde7b3",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3",
"JobStatus": "SUBMITTED"
}
```
Contents of `output.txt` with line of indents for readability:
```
{
"File": "SampleMovieReview1.txt",
"Line": 0,
"Sentiment": "MIXED",
"SentimentScore": {
"Mixed": 0.6591159105300903,
"Negative": 0.26492202281951904,
"Neutral": 0.035430654883384705,
"Positive": 0.04053137078881264
}
}
{
"File": "SampleMovieReview2.txt",
"Line": 0,
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0.000008718466233403888,
"Negative": 0.00006134175055194646,
"Neutral": 0.0002941041602753103,
"Positive": 0.9996358156204224
}
}
{
"File": "SampleMovieReview3.txt",
"Line": 0,
"Sentiment": "NEGATIVE",
"SentimentScore": {
"Mixed": 0.004146667663007975,
"Negative": 0.9645107984542847,
"Neutral": 0.016559595242142677,
"Positive": 0.014782938174903393
}
}
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `start-targeted-sentiment-detection-job`
The following code example shows how to use `start-targeted-sentiment-detection-job`.
**AWS CLI**
**To start an asynchronous targeted sentiment analysis job**
The following `start-targeted-sentiment-detection-job` example starts an asynchronous targeted sentiment analysis detection job for all files located at the address specified by the `--input-data-config` tag. The S3 bucket folder in this example contains `SampleMovieReview1.txt`, `SampleMovieReview2.txt`, and `SampleMovieReview3.txt`. When the job is complete, `output.tar.gz` is placed at the location specified by the `--output-data-config` tag. `output.tar.gz` contains the files `SampleMovieReview1.txt.out`, `SampleMovieReview2.txt.out`, and `SampleMovieReview3.txt.out`, which each contain all of the named entities and associated sentiments for a single input text file.
```
aws comprehend start-targeted-sentiment-detection-job \
--job-name targeted_movie_review_analysis1 \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role
```
Contents of `SampleMovieReview1.txt`:
```
"The film, AnyMovie, is fairly predictable and just okay."
```
Contents of `SampleMovieReview2.txt`:
```
"AnyMovie is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie."
```
Contents of `SampleMovieReview3.txt`:
```
"Don't get fooled by the 'awards' for AnyMovie. All parts of the film were poorly stolen from other modern directors."
```
Output:
```
{
"JobId": "0b5001e25f62ebb40631a9a1a7fde7b3",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3",
"JobStatus": "SUBMITTED"
}
```
Contents of `SampleMovieReview1.txt.out` with line indents for readability:
```
{
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 4,
"EndOffset": 8,
"Score": 0.994972,
"GroupScore": 1,
"Text": "film",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 10,
"EndOffset": 18,
"Score": 0.631368,
"GroupScore": 1,
"Text": "AnyMovie",
"Type": "ORGANIZATION",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0.001729,
"Negative": 0.000001,
"Neutral": 0.000318,
"Positive": 0.997952
}
}
}
]
}
],
"File": "SampleMovieReview1.txt",
"Line": 0
}
```
Contents of `SampleMovieReview2.txt.out` line indents for readability:
```
{
"Entities": [
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 0,
"EndOffset": 8,
"Score": 0.854024,
"GroupScore": 1,
"Text": "AnyMovie",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 0.000007,
"Positive": 0.999993
}
}
},
{
"BeginOffset": 104,
"EndOffset": 109,
"Score": 0.999129,
"GroupScore": 0.502937,
"Text": "movie",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 0,
"Positive": 1
}
}
},
{
"BeginOffset": 33,
"EndOffset": 37,
"Score": 0.999823,
"GroupScore": 0.999252,
"Text": "film",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 0.000001,
"Positive": 0.999999
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0,
1,
2
],
"Mentions": [
{
"BeginOffset": 43,
"EndOffset": 44,
"Score": 0.999997,
"GroupScore": 1,
"Text": "I",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
},
{
"BeginOffset": 80,
"EndOffset": 81,
"Score": 0.999996,
"GroupScore": 0.52523,
"Text": "I",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
},
{
"BeginOffset": 67,
"EndOffset": 68,
"Score": 0.999994,
"GroupScore": 0.999499,
"Text": "I",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 75,
"EndOffset": 78,
"Score": 0.999978,
"GroupScore": 1,
"Text": "kid",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
}
]
}
],
"File": "SampleMovieReview2.txt",
"Line": 0
}
```
Contents of `SampleMovieReview3.txt.out` with line indents for readability:
```
{
"Entities": [
{
"DescriptiveMentionIndex": [
1
],
"Mentions": [
{
"BeginOffset": 64,
"EndOffset": 68,
"Score": 0.992953,
"GroupScore": 0.999814,
"Text": "film",
"Type": "MOVIE",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0.000004,
"Negative": 0.010425,
"Neutral": 0.989543,
"Positive": 0.000027
}
}
},
{
"BeginOffset": 37,
"EndOffset": 45,
"Score": 0.999782,
"GroupScore": 1,
"Text": "AnyMovie",
"Type": "ORGANIZATION",
"MentionSentiment": {
"Sentiment": "POSITIVE",
"SentimentScore": {
"Mixed": 0.000095,
"Negative": 0.039847,
"Neutral": 0.000673,
"Positive": 0.959384
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 47,
"EndOffset": 50,
"Score": 0.999991,
"GroupScore": 1,
"Text": "All",
"Type": "QUANTITY",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0.000001,
"Negative": 0.000001,
"Neutral": 0.999998,
"Positive": 0
}
}
}
]
},
{
"DescriptiveMentionIndex": [
0
],
"Mentions": [
{
"BeginOffset": 106,
"EndOffset": 115,
"Score": 0.542083,
"GroupScore": 1,
"Text": "directors",
"Type": "PERSON",
"MentionSentiment": {
"Sentiment": "NEUTRAL",
"SentimentScore": {
"Mixed": 0,
"Negative": 0,
"Neutral": 1,
"Positive": 0
}
}
}
]
}
],
"File": "SampleMovieReview3.txt",
"Line": 0
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-targeted-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `start-topics-detection-job`
The following code example shows how to use `start-topics-detection-job`.
**AWS CLI**
**To start a topics detection analysis job**
The following `start-topics-detection-job` example starts an asynchronous topics detection job for all files located at the address specified by the `--input-data-config` tag. When the job is complete, the folder, `output`, is placed at the location specified by the `--ouput-data-config` tag. `output` contains topic-terms.csv and doc-topics.csv. The first output file, topic-terms.csv, is a list of topics in the collection. For each topic, the list includes, by default, the top terms by topic according to their weight. The second file, `doc-topics.csv`, lists the documents associated with a topic and the proportion of the document that is concerned with the topic.
```
aws comprehend start-topics-detection-job \
--job-name example_topics_detection_job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
```
For more information, see [Topic Modeling](https://docs.aws.amazon.com/comprehend/latest/dg/topic-modeling.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StartTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-topics-detection-job.html) in *AWS CLI Command Reference*.
### `stop-dominant-language-detection-job`
The following code example shows how to use `stop-dominant-language-detection-job`.
**AWS CLI**
**To stop an asynchronous dominant language detection job**
The following `stop-dominant-language-detection-job` example stops an in-progress, asynchronous dominant language detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-dominant-language-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-dominant-language-detection-job.html) in *AWS CLI Command Reference*.
### `stop-entities-detection-job`
The following code example shows how to use `stop-entities-detection-job`.
**AWS CLI**
**To stop an asynchronous entities detection job**
The following `stop-entities-detection-job` example stops an in-progress, asynchronous entities detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-entities-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-entities-detection-job.html) in *AWS CLI Command Reference*.
### `stop-events-detection-job`
The following code example shows how to use `stop-events-detection-job`.
**AWS CLI**
**To stop an asynchronous events detection job**
The following `stop-events-detection-job` example stops an in-progress, asynchronous events detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-events-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-events-detection-job.html) in *AWS CLI Command Reference*.
### `stop-key-phrases-detection-job`
The following code example shows how to use `stop-key-phrases-detection-job`.
**AWS CLI**
**To stop an asynchronous key phrases detection job**
The following `stop-key-phrases-detection-job` example stops an in-progress, asynchronous key phrases detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-key-phrases-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-key-phrases-detection-job.html) in *AWS CLI Command Reference*.
### `stop-pii-entities-detection-job`
The following code example shows how to use `stop-pii-entities-detection-job`.
**AWS CLI**
**To stop an asynchronous pii entities detection job**
The following `stop-pii-entities-detection-job` example stops an in-progress, asynchronous pii entities detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-pii-entities-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-pii-entities-detection-job.html) in *AWS CLI Command Reference*.
### `stop-sentiment-detection-job`
The following code example shows how to use `stop-sentiment-detection-job`.
**AWS CLI**
**To stop an asynchronous sentiment detection job**
The following `stop-sentiment-detection-job` example stops an in-progress, asynchronous sentiment detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-sentiment-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `stop-targeted-sentiment-detection-job`
The following code example shows how to use `stop-targeted-sentiment-detection-job`.
**AWS CLI**
**To stop an asynchronous targeted sentiment detection job**
The following `stop-targeted-sentiment-detection-job` example stops an in-progress, asynchronous targeted sentiment detection job. If the current job state is `IN_PROGRESS` the job is marked for termination and put into the `STOP_REQUESTED` state. If the job completes before it can be stopped, it is put into the `COMPLETED` state.
```
aws comprehend stop-targeted-sentiment-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
```
Output:
```
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE,
"JobStatus": "STOP_REQUESTED"
}
```
For more information, see [Async analysis for Amazon Comprehend insights](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-targeted-sentiment-detection-job.html) in *AWS CLI Command Reference*.
### `stop-training-document-classifier`
The following code example shows how to use `stop-training-document-classifier`.
**AWS CLI**
**To stop the training of a document classifier model**
The following `stop-training-document-classifier` example stops the training of a document classifier model while in-progress.
```
aws comprehend stop-training-document-classifier
--document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier
```
This command produces no output.
For more information, see [Creating and managing custom models](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopTrainingDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-document-classifier.html) in *AWS CLI Command Reference*.
### `stop-training-entity-recognizer`
The following code example shows how to use `stop-training-entity-recognizer`.
**AWS CLI**
**To stop the training of an entity recognizer model**
The following `stop-training-entity-recognizer` example stops the training of an entity recognizer model while in-progress.
```
aws comprehend stop-training-entity-recognizer
--entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/examplerecognizer1"
```
This command produces no output.
For more information, see [Creating and managing custom models](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [StopTrainingEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-entity-recognizer.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**Example 1: To tag a resource**
The following `tag-resource` example adds a single tag to an Amazon Comprehend resource.
```
aws comprehend tag-resource \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \
--tags Key=Location,Value=Seattle
```
This command has no output.
For more information, see [Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) in the *Amazon Comprehend Developer Guide*.
**Example 2: To add multiple tags to a resource**
The following `tag-resource` example adds multiple tags to an Amazon Comprehend resource.
```
aws comprehend tag-resource \
--resource-arn "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1" \
--tags Key=location,Value=Seattle Key=Department,Value=Finance
```
This command has no output.
For more information, see [Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**Example 1: To remove a single tag from a resource**
The following `untag-resource` example removes a single tag from an Amazon Comprehend resource.
```
aws comprehend untag-resource \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1
--tag-keys Location
```
This command produces no output.
For more information, see [Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) in the *Amazon Comprehend Developer Guide*.
**Example 2: To remove multiple tags from a resource**
The following `untag-resource` example removes multiple tags from an Amazon Comprehend resource.
```
aws comprehend untag-resource \
--resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1
--tag-keys Location Department
```
This command produces no output.
For more information, see [Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/untag-resource.html) in *AWS CLI Command Reference*.
### `update-endpoint`
The following code example shows how to use `update-endpoint`.
**AWS CLI**
**Example 1: To update an endpoint's inference units**
The following `update-endpoint` example updates information about an endpoint. In this example, the number of inference units is increased.
```
aws comprehend update-endpoint \
--endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint
--desired-inference-units 2
```
This command produces no output.
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
**Example 2: To update an endpoint's actie model**
The following `update-endpoint` example updates information about an endpoint. In this example, the active model is changed.
```
aws comprehend update-endpoint \
--endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint
--active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-new
```
This command produces no output.
For more information, see [Managing Amazon Comprehend endpoints](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [UpdateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-endpoint.html) in *AWS CLI Command Reference*.
### `update-flywheel`
The following code example shows how to use `update-flywheel`.
**AWS CLI**
**To update a flywheel configuration**
The following `update-flywheel` example updates a flywheel configuration. In this example, the active model for the flywheel is updated.
```
aws comprehend update-flywheel \
--flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1 \
--active-model-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model
```
Output:
```
{
"FlywheelProperties": {
"FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity",
"ActiveModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/new-example-classifier-model",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
"TaskConfig": {
"LanguageCode": "en",
"DocumentClassificationConfig": {
"Mode": "MULTI_CLASS"
}
},
"DataLakeS3Uri": "s3://amzn-s3-demo-bucket/flywheel-entity/schemaVersion=1/20230616T200543Z/",
"DataSecurityConfig": {},
"Status": "ACTIVE",
"ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": "2023-06-16T20:05:43.242000+00:00",
"LastModifiedTime": "2023-06-19T04:00:43.027000+00:00",
"LatestFlywheelIteration": "20230619T040032Z"
}
}
```
For more information, see [Flywheel overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the *Amazon Comprehend Developer Guide*.
+ For API details, see [UpdateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-flywheel.html) in *AWS CLI Command Reference*.
# Amazon Comprehend Medical examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Comprehend Medical.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `describe-entities-detection-v2-job`
The following code example shows how to use `describe-entities-detection-v2-job`.
**AWS CLI**
**To describe an entities detection job**
The following `describe-entities-detection-v2-job` example displays the properties associated with an asynchronous entity detection job.
```
aws comprehendmedical describe-entities-detection-v2-job \
--job-id "ab9887877365fe70299089371c043b96"
```
Output:
```
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "ab9887877365fe70299089371c043b96",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-03-18T21:20:15.614000+00:00",
"EndTime": "2020-03-18T21:27:07.350000+00:00",
"ExpirationTime": "2020-07-16T21:20:15+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": ""
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "DetectEntitiesModelV20190930"
}
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DescribeEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-entities-detection-v2-job.html) in *AWS CLI Command Reference*.
### `describe-icd10-cm-inference-job`
The following code example shows how to use `describe-icd10-cm-inference-job`.
**AWS CLI**
**To describe an ICD-10-CM inference job**
The following `describe-icd10-cm-inference-job` example describes the properties of the requested inference job with the specified job-id.
```
aws comprehendmedical describe-icd10-cm-inference-job \
--job-id "5780034166536cdb52ffa3295a1b00a7"
```
Output:
```
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "5780034166536cdb52ffa3295a1b00a7",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-05-18T21:20:15.614000+00:00",
"EndTime": "2020-05-18T21:27:07.350000+00:00",
"ExpirationTime": "2020-09-16T21:20:15+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.1.0"
}
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DescribeIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-icd10-cm-inference-job.html) in *AWS CLI Command Reference*.
### `describe-phi-detection-job`
The following code example shows how to use `describe-phi-detection-job`.
**AWS CLI**
**To describe a PHI detection job**
The following `describe-phi-detection-job` example displays the properties associated with an asynchronous protected health information (PHI) detection job.
```
aws comprehendmedical describe-phi-detection-job \
--job-id "4750034166536cdb52ffa3295a1b00a3"
```
Output:
```
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "4750034166536cdb52ffa3295a1b00a3",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-03-19T20:38:37.594000+00:00",
"EndTime": "2020-03-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-07-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": ""
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "PHIModelV20190903"
}
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DescribePhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-phi-detection-job.html) in *AWS CLI Command Reference*.
### `describe-rx-norm-inference-job`
The following code example shows how to use `describe-rx-norm-inference-job`.
**AWS CLI**
**To describe an RxNorm inference job**
The following `describe-rx-norm-inference-job` example describes the properties of the requested inference job with the specified job-id.
```
aws comprehendmedical describe-rx-norm-inference-job \
--job-id "eg8199877365fc70299089371c043b96"
```
Output:
```
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "g8199877365fc70299089371c043b96",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-05-18T21:20:15.614000+00:00",
"EndTime": "2020-05-18T21:27:07.350000+00:00",
"ExpirationTime": "2020-09-16T21:20:15+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.0.0"
}
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DescribeRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-rx-norm-inference-job.html) in *AWS CLI Command Reference*.
### `describe-snomedct-inference-job`
The following code example shows how to use `describe-snomedct-inference-job`.
**AWS CLI**
**To describe an SNOMED CT inference job**
The following `describe-snomedct-inference-job` example describes the properties of the requested inference job with the specified job-id.
```
aws comprehendmedical describe-snomedct-inference-job \
--job-id "2630034166536cdb52ffa3295a1b00a7"
```
Output:
```
{
"ComprehendMedicalAsyncJobProperties": {
"JobId": "2630034166536cdb52ffa3295a1b00a7",
"JobStatus": "COMPLETED",
"SubmitTime": "2021-12-18T21:20:15.614000+00:00",
"EndTime": "2021-12-18T21:27:07.350000+00:00",
"ExpirationTime": "2022-05-16T21:20:15+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.1.0"
}
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DescribeSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-snomedct-inference-job.html) in *AWS CLI Command Reference*.
### `detect-entities-v2`
The following code example shows how to use `detect-entities-v2`.
**AWS CLI**
**Example 1: To detect entities directly from text**
The following `detect-entities-v2` example shows the detected entities and labels them according to type, directly from input text.
```
aws comprehendmedical detect-entities-v2 \
--text "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy."
```
Output:
```
{
"Id": 0,
"BeginOffset": 38,
"EndOffset": 47,
"Score": 0.9942955374717712,
"Text": "Clonidine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Traits": []
}
```
For more information, see [Detect Entities Version 2](https://docs.aws.amazon.com/comprehend/latest/dg/extracted-med-info-V2.html) in the *Amazon Comprehend Medical Developer Guide*.
**Example 2: To detect entities from a file path**
The following `detect-entities-v2` example shows the detected entities and labels them according to type from a file path.
```
aws comprehendmedical detect-entities-v2 \
--text file://medical_entities.txt
```
Contents of `medical_entities.txt`:
```
{
"Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy."
}
```
Output:
```
{
"Id": 0,
"BeginOffset": 38,
"EndOffset": 47,
"Score": 0.9942955374717712,
"Text": "Clonidine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Traits": []
}
```
For more information, see [Detect Entities Version 2](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-entitiesv2.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DetectEntitiesV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-entities-v2.html) in *AWS CLI Command Reference*.
### `detect-phi`
The following code example shows how to use `detect-phi`.
**AWS CLI**
**Example 1: To detect protected health information (PHI) directly from text**
The following `detect-phi` example displays the detected protected health information (PHI) entities directly from input text.
```
aws comprehendmedical detect-phi \
--text "Patient Carlos Salazar presented with rash on his upper extremities and dry cough. He lives at 100 Main Street, Anytown, USA where he works from his home as a carpenter."
```
Output:
```
{
"Entities": [
{
"Id": 0,
"BeginOffset": 8,
"EndOffset": 21,
"Score": 0.9914507269859314,
"Text": "Carlos Salazar",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "NAME",
"Traits": []
},
{
"Id": 1,
"BeginOffset": 94,
"EndOffset": 109,
"Score": 0.871849775314331,
"Text": "100 Main Street, Anytown, USA",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "ADDRESS",
"Traits": []
},
{
"Id": 2,
"BeginOffset": 145,
"EndOffset": 154,
"Score": 0.8302185535430908,
"Text": "carpenter",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "PROFESSION",
"Traits": []
}
],
"ModelVersion": "0.0.0"
}
```
For more information, see [Detect PHI](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-phi.html) in the *Amazon Comprehend Medical Developer Guide*.
**Example 2: To detect protect health information (PHI) directly from a file path**
The following `detect-phi` example shows the detected protected health information (PHI) entities from a file path.
```
aws comprehendmedical detect-phi \
--text file://phi.txt
```
Contents of `phi.txt`:
```
"Patient Carlos Salazar presented with a rash on his upper extremities and a dry cough. He lives at 100 Main Street, Anytown, USA, where he works from his home as a carpenter."
```
Output:
```
{
"Entities": [
{
"Id": 0,
"BeginOffset": 8,
"EndOffset": 21,
"Score": 0.9914507269859314,
"Text": "Carlos Salazar",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "NAME",
"Traits": []
},
{
"Id": 1,
"BeginOffset": 94,
"EndOffset": 109,
"Score": 0.871849775314331,
"Text": "100 Main Street, Anytown, USA",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "ADDRESS",
"Traits": []
},
{
"Id": 2,
"BeginOffset": 145,
"EndOffset": 154,
"Score": 0.8302185535430908,
"Text": "carpenter",
"Category": "PROTECTED_HEALTH_INFORMATION",
"Type": "PROFESSION",
"Traits": []
}
],
"ModelVersion": "0.0.0"
}
```
For more information, see [Detect PHI](https://docs.aws.amazon.com/comprehend/latest/dg/how-medical-phi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [DetectPhi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-phi.html) in *AWS CLI Command Reference*.
### `infer-icd10-cm`
The following code example shows how to use `infer-icd10-cm`.
**AWS CLI**
**Example 1: To detect medical condition entities and link to the ICD-10-CM Ontology directly from text**
The following `infer-icd10-cm` example labels the detected medical condition entities and links those entities with codes in the 2019 edition of the International Classification of Diseases Clinical Modification (ICD-10-CM).
```
aws comprehendmedical infer-icd10-cm \
--text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily."
```
Output:
```
{
"Entities": [
{
"Id": 0,
"Text": "abdominal pain",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Score": 0.9475538730621338,
"BeginOffset": 28,
"EndOffset": 42,
"Attributes": [],
"Traits": [
{
"Name": "SYMPTOM",
"Score": 0.6724207401275635
}
],
"ICD10CMConcepts": [
{
"Description": "Unspecified abdominal pain",
"Code": "R10.9",
"Score": 0.6904221177101135
},
{
"Description": "Epigastric pain",
"Code": "R10.13",
"Score": 0.1364113688468933
},
{
"Description": "Generalized abdominal pain",
"Code": "R10.84",
"Score": 0.12508003413677216
},
{
"Description": "Left lower quadrant pain",
"Code": "R10.32",
"Score": 0.10063883662223816
},
{
"Description": "Lower abdominal pain, unspecified",
"Code": "R10.30",
"Score": 0.09933677315711975
}
]
},
{
"Id": 1,
"Text": "diabetes",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Score": 0.9899052977561951,
"BeginOffset": 75,
"EndOffset": 83,
"Attributes": [],
"Traits": [
{
"Name": "DIAGNOSIS",
"Score": 0.9258432388305664
}
],
"ICD10CMConcepts": [
{
"Description": "Type 2 diabetes mellitus without complications",
"Code": "E11.9",
"Score": 0.7158446311950684
},
{
"Description": "Family history of diabetes mellitus",
"Code": "Z83.3",
"Score": 0.5704703330993652
},
{
"Description": "Family history of other endocrine, nutritional and metabolic diseases",
"Code": "Z83.49",
"Score": 0.19856023788452148
},
{
"Description": "Type 1 diabetes mellitus with ketoacidosis without coma",
"Code": "E10.10",
"Score": 0.13285516202449799
},
{
"Description": "Type 2 diabetes mellitus with hyperglycemia",
"Code": "E11.65",
"Score": 0.0993388369679451
}
]
}
],
"ModelVersion": "0.1.0"
}
```
For more information, see [Infer ICD10-CM](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-icd10.html) in the *Amazon Comprehend Medical Developer Guide*.
**Example 2: To detect medical condition entities and link to the ICD-10-CM Ontology from a file pathway**
The following `infer-icd-10-cm` example labels the detected medical condition entities and links those entities with codes in the 2019 edition of the International Classification of Diseases Clinical Modification (ICD-10-CM).
```
aws comprehendmedical infer-icd10-cm \
--text file://icd10cm.txt
```
Contents of `icd10cm.txt`:
```
{
"The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily."
}
```
Output:
```
{
"Entities": [
{
"Id": 0,
"Text": "abdominal pain",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Score": 0.9475538730621338,
"BeginOffset": 28,
"EndOffset": 42,
"Attributes": [],
"Traits": [
{
"Name": "SYMPTOM",
"Score": 0.6724207401275635
}
],
"ICD10CMConcepts": [
{
"Description": "Unspecified abdominal pain",
"Code": "R10.9",
"Score": 0.6904221177101135
},
{
"Description": "Epigastric pain",
"Code": "R10.13",
"Score": 0.1364113688468933
},
{
"Description": "Generalized abdominal pain",
"Code": "R10.84",
"Score": 0.12508003413677216
},
{
"Description": "Left lower quadrant pain",
"Code": "R10.32",
"Score": 0.10063883662223816
},
{
"Description": "Lower abdominal pain, unspecified",
"Code": "R10.30",
"Score": 0.09933677315711975
}
]
},
{
"Id": 1,
"Text": "diabetes",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Score": 0.9899052977561951,
"BeginOffset": 75,
"EndOffset": 83,
"Attributes": [],
"Traits": [
{
"Name": "DIAGNOSIS",
"Score": 0.9258432388305664
}
],
"ICD10CMConcepts": [
{
"Description": "Type 2 diabetes mellitus without complications",
"Code": "E11.9",
"Score": 0.7158446311950684
},
{
"Description": "Family history of diabetes mellitus",
"Code": "Z83.3",
"Score": 0.5704703330993652
},
{
"Description": "Family history of other endocrine, nutritional and metabolic diseases",
"Code": "Z83.49",
"Score": 0.19856023788452148
},
{
"Description": "Type 1 diabetes mellitus with ketoacidosis without coma",
"Code": "E10.10",
"Score": 0.13285516202449799
},
{
"Description": "Type 2 diabetes mellitus with hyperglycemia",
"Code": "E11.65",
"Score": 0.0993388369679451
}
]
}
],
"ModelVersion": "0.1.0"
}
```
For more information, see [Infer-ICD10-CM](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-icd10.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [InferIcd10Cm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-icd10-cm.html) in *AWS CLI Command Reference*.
### `infer-rx-norm`
The following code example shows how to use `infer-rx-norm`.
**AWS CLI**
**Example 1: To detect medication entities and link to RxNorm directly from text**
The following `infer-rx-norm` example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database.
```
aws comprehendmedical infer-rx-norm \
--text "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid."
```
Output:
```
{
"Entities": [
{
"Id": 0,
"Text": "Levothyroxine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Score": 0.9996285438537598,
"BeginOffset": 23,
"EndOffset": 36,
"Attributes": [
{
"Type": "DOSAGE",
"Score": 0.9892290830612183,
"RelationshipScore": 0.9997978806495667,
"Id": 1,
"BeginOffset": 37,
"EndOffset": 51,
"Text": "125 micrograms",
"Traits": []
},
{
"Type": "ROUTE_OR_MODE",
"Score": 0.9988924860954285,
"RelationshipScore": 0.998291552066803,
"Id": 2,
"BeginOffset": 52,
"EndOffset": 56,
"Text": "p.o.",
"Traits": []
},
{
"Type": "FREQUENCY",
"Score": 0.9953463673591614,
"RelationshipScore": 0.9999889135360718,
"Id": 3,
"BeginOffset": 57,
"EndOffset": 67,
"Text": "once daily",
"Traits": []
}
],
"Traits": [],
"RxNormConcepts": [
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet",
"Code": "966224",
"Score": 0.9912070631980896
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Capsule",
"Code": "966405",
"Score": 0.8698278665542603
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.7448257803916931
},
{
"Description": "levothyroxine",
"Code": "10582",
"Score": 0.7050482630729675
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]",
"Code": "966190",
"Score": 0.6921631693840027
}
]
},
{
"Id": 4,
"Text": "Synthroid",
"Category": "MEDICATION",
"Type": "BRAND_NAME",
"Score": 0.9946461319923401,
"BeginOffset": 86,
"EndOffset": 95,
"Attributes": [],
"Traits": [
{
"Name": "NEGATION",
"Score": 0.5167351961135864
}
],
"RxNormConcepts": [
{
"Description": "Synthroid",
"Code": "224920",
"Score": 0.9462039470672607
},
{
"Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]",
"Code": "966282",
"Score": 0.8309829235076904
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.4945160448551178
},
{
"Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]",
"Code": "966247",
"Score": 0.3674522042274475
},
{
"Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]",
"Code": "966158",
"Score": 0.2588822841644287
}
]
}
],
"ModelVersion": "0.0.0"
}
```
For more information, see [Infer RxNorm](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-rxnorm.html) in the *Amazon Comprehend Medical Developer Guide*.
**Example 2: To detect medication entities and link to RxNorm from a file path.**
The following `infer-rx-norm` example shows and labels the detected medication entities and links those entities to concept identifiers (RxCUI) from the National Library of Medicine RxNorm database.
```
aws comprehendmedical infer-rx-norm \
--text file://rxnorm.txt
```
Contents of `rxnorm.txt`:
```
{
"Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid."
}
```
Output:
```
{
"Entities": [
{
"Id": 0,
"Text": "Levothyroxine",
"Category": "MEDICATION",
"Type": "GENERIC_NAME",
"Score": 0.9996285438537598,
"BeginOffset": 23,
"EndOffset": 36,
"Attributes": [
{
"Type": "DOSAGE",
"Score": 0.9892290830612183,
"RelationshipScore": 0.9997978806495667,
"Id": 1,
"BeginOffset": 37,
"EndOffset": 51,
"Text": "125 micrograms",
"Traits": []
},
{
"Type": "ROUTE_OR_MODE",
"Score": 0.9988924860954285,
"RelationshipScore": 0.998291552066803,
"Id": 2,
"BeginOffset": 52,
"EndOffset": 56,
"Text": "p.o.",
"Traits": []
},
{
"Type": "FREQUENCY",
"Score": 0.9953463673591614,
"RelationshipScore": 0.9999889135360718,
"Id": 3,
"BeginOffset": 57,
"EndOffset": 67,
"Text": "once daily",
"Traits": []
}
],
"Traits": [],
"RxNormConcepts": [
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet",
"Code": "966224",
"Score": 0.9912070631980896
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Capsule",
"Code": "966405",
"Score": 0.8698278665542603
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.7448257803916931
},
{
"Description": "levothyroxine",
"Code": "10582",
"Score": 0.7050482630729675
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Levoxyl]",
"Code": "966190",
"Score": 0.6921631693840027
}
]
},
{
"Id": 4,
"Text": "Synthroid",
"Category": "MEDICATION",
"Type": "BRAND_NAME",
"Score": 0.9946461319923401,
"BeginOffset": 86,
"EndOffset": 95,
"Attributes": [],
"Traits": [
{
"Name": "NEGATION",
"Score": 0.5167351961135864
}
],
"RxNormConcepts": [
{
"Description": "Synthroid",
"Code": "224920",
"Score": 0.9462039470672607
},
{
"Description": "Levothyroxine Sodium 0.088 MG Oral Tablet [Synthroid]",
"Code": "966282",
"Score": 0.8309829235076904
},
{
"Description": "Levothyroxine Sodium 0.125 MG Oral Tablet [Synthroid]",
"Code": "966191",
"Score": 0.4945160448551178
},
{
"Description": "Levothyroxine Sodium 0.05 MG Oral Tablet [Synthroid]",
"Code": "966247",
"Score": 0.3674522042274475
},
{
"Description": "Levothyroxine Sodium 0.025 MG Oral Tablet [Synthroid]",
"Code": "966158",
"Score": 0.2588822841644287
}
]
}
],
"ModelVersion": "0.0.0"
}
```
For more information, see [Infer RxNorm](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-RxNorm.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [InferRxNorm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-rx-norm.html) in *AWS CLI Command Reference*.
### `infer-snomedct`
The following code example shows how to use `infer-snomedct`.
**AWS CLI**
**Example: To detect entities and link to the SNOMED CT Ontology directly from text**
The following `infer-snomedct` example shows how to detect medical entities and link them to concepts from the 2021-03 version of the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED CT).
```
aws comprehendmedical infer-snomedct \
--text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily."
```
Output:
```
{
"Entities": [
{
"Id": 3,
"BeginOffset": 26,
"EndOffset": 40,
"Score": 0.9598260521888733,
"Text": "abdominal pain",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Traits": [
{
"Name": "SYMPTOM",
"Score": 0.6819021701812744
}
]
},
{
"Id": 4,
"BeginOffset": 73,
"EndOffset": 81,
"Score": 0.9905840158462524,
"Text": "diabetes",
"Category": "MEDICAL_CONDITION",
"Type": "DX_NAME",
"Traits": [
{
"Name": "DIAGNOSIS",
"Score": 0.9255214333534241
}
]
},
{
"Id": 1,
"BeginOffset": 95,
"EndOffset": 104,
"Score": 0.6371926665306091,
"Text": "Micronase",
"Category": "MEDICATION",
"Type": "BRAND_NAME",
"Traits": [],
"Attributes": [
{
"Type": "FREQUENCY",
"Score": 0.9761165380477905,
"RelationshipScore": 0.9984188079833984,
"RelationshipType": "FREQUENCY",
"Id": 2,
"BeginOffset": 105,
"EndOffset": 110,
"Text": "daily",
"Category": "MEDICATION",
"Traits": []
}
]
}
],
"UnmappedAttributes": [],
"ModelVersion": "1.0.0"
}
```
For more information, see [InferSNOMEDCT](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-linking-snomed.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [InferSnomedct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-snomedct.html) in *AWS CLI Command Reference*.
### `list-entities-detection-v2-jobs`
The following code example shows how to use `list-entities-detection-v2-jobs`.
**AWS CLI**
**To list entities detection jobs**
The following `list-entities-detection-v2-jobs` example lists current asynchronous detection jobs.
```
aws comprehendmedical list-entities-detection-v2-jobs
```
Output:
```
{
"ComprehendMedicalAsyncJobPropertiesList": [
{
"JobId": "ab9887877365fe70299089371c043b96",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-03-19T20:38:37.594000+00:00",
"EndTime": "2020-03-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-07-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": ""
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "867139942017-EntitiesDetection-ab9887877365fe70299089371c043b96/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "DetectEntitiesModelV20190930"
}
]
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [ListEntitiesDetectionV2Jobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-entities-detection-v2-jobs.html) in *AWS CLI Command Reference*.
### `list-icd10-cm-inference-jobs`
The following code example shows how to use `list-icd10-cm-inference-jobs`.
**AWS CLI**
**To list all current ICD-10-CM inference jobs**
The following example shows how the `list-icd10-cm-inference-jobs` operation returns a list of current asynchronous ICD-10-CM batch inference jobs.
```
aws comprehendmedical list-icd10-cm-inference-jobs
```
Output:
```
{
"ComprehendMedicalAsyncJobPropertiesList": [
{
"JobId": "5780034166536cdb52ffa3295a1b00a7",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-05-19T20:38:37.594000+00:00",
"EndTime": "2020-05-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-09-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.1.0"
}
]
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [ListIcd10CmInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-icd10-cm-inference-jobs.html) in *AWS CLI Command Reference*.
### `list-phi-detection-jobs`
The following code example shows how to use `list-phi-detection-jobs`.
**AWS CLI**
**To list protected health information (PHI) detection jobs**
The following `list-phi-detection-jobs` example lists current protected health information (PHI) detection jobs
```
aws comprehendmedical list-phi-detection-jobs
```
Output:
```
{
"ComprehendMedicalAsyncJobPropertiesList": [
{
"JobId": "4750034166536cdb52ffa3295a1b00a3",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-03-19T20:38:37.594000+00:00",
"EndTime": "2020-03-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-07-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": ""
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "867139942017-PHIDetection-4750034166536cdb52ffa3295a1b00a3/"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "PHIModelV20190903"
}
]
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [ListPhiDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-phi-detection-jobs.html) in *AWS CLI Command Reference*.
### `list-rx-norm-inference-jobs`
The following code example shows how to use `list-rx-norm-inference-jobs`.
**AWS CLI**
**To list all current Rx-Norm inference jobs**
The following example shows how `list-rx-norm-inference-jobs` returns a list of current asynchronous Rx-Norm batch inference jobs.
```
aws comprehendmedical list-rx-norm-inference-jobs
```
Output:
```
{
"ComprehendMedicalAsyncJobPropertiesList": [
{
"JobId": "4980034166536cfb52gga3295a1b00a3",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-05-19T20:38:37.594000+00:00",
"EndTime": "2020-05-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-09-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.0.0"
}
]
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [ListRxNormInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-rx-norm-inference-jobs.html) in *AWS CLI Command Reference*.
### `list-snomedct-inference-jobs`
The following code example shows how to use `list-snomedct-inference-jobs`.
**AWS CLI**
**To list all SNOMED CT inference jobs**
The following example shows how the `list-snomedct-inference-jobs` operation returns a list of current asynchronous SNOMED CT batch inference jobs.
```
aws comprehendmedical list-snomedct-inference-jobs
```
Output:
```
{
"ComprehendMedicalAsyncJobPropertiesList": [
{
"JobId": "5780034166536cdb52ffa3295a1b00a7",
"JobStatus": "COMPLETED",
"SubmitTime": "2020-05-19T20:38:37.594000+00:00",
"EndTime": "2020-05-19T20:45:07.894000+00:00",
"ExpirationTime": "2020-09-17T20:38:37+00:00",
"InputDataConfig": {
"S3Bucket": "comp-med-input",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"OutputDataConfig": {
"S3Bucket": "comp-med-output",
"S3Key": "AKIAIOSFODNN7EXAMPLE"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole",
"ModelVersion": "0.1.0"
}
]
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [ListSnomedctInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-snomedct-inference-jobs.html) in *AWS CLI Command Reference*.
### `start-entities-detection-v2-job`
The following code example shows how to use `start-entities-detection-v2-job`.
**AWS CLI**
**To start an entities detection job**
The following `start-entities-detection-v2-job` example starts an asynchronous entity detection job.
```
aws comprehendmedical start-entities-detection-v2-job \
--input-data-config "S3Bucket=comp-med-input" \
--output-data-config "S3Bucket=comp-med-output" \
--data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
--language-code en
```
Output:
```
{
"JobId": "ab9887877365fe70299089371c043b96"
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StartEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-entities-detection-v2-job.html) in *AWS CLI Command Reference*.
### `start-icd10-cm-inference-job`
The following code example shows how to use `start-icd10-cm-inference-job`.
**AWS CLI**
**To start an ICD-10-CM inference job**
The following `start-icd10-cm-inference-job` example starts an ICD-10-CM inference batch analysis job.
```
aws comprehendmedical start-icd10-cm-inference-job \
--input-data-config "S3Bucket=comp-med-input" \
--output-data-config "S3Bucket=comp-med-output" \
--data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
--language-code en
```
Output:
```
{
"JobId": "ef7289877365fc70299089371c043b96"
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StartIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-icd10-cm-inference-job.html) in *AWS CLI Command Reference*.
### `start-phi-detection-job`
The following code example shows how to use `start-phi-detection-job`.
**AWS CLI**
**To start a PHI detection job**
The following `start-phi-detection-job` example starts an asynchronous PHI entity detection job.
```
aws comprehendmedical start-phi-detection-job \
--input-data-config "S3Bucket=comp-med-input" \
--output-data-config "S3Bucket=comp-med-output" \
--data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
--language-code en
```
Output:
```
{
"JobId": "ab9887877365fe70299089371c043b96"
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StartPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-phi-detection-job.html) in *AWS CLI Command Reference*.
### `start-rx-norm-inference-job`
The following code example shows how to use `start-rx-norm-inference-job`.
**AWS CLI**
**To start an RxNorm inference job**
The following `start-rx-norm-inference-job` example starts an RxNorm inference batch analysis job.
```
aws comprehendmedical start-rx-norm-inference-job \
--input-data-config "S3Bucket=comp-med-input" \
--output-data-config "S3Bucket=comp-med-output" \
--data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
--language-code en
```
Output:
```
{
"JobId": "eg8199877365fc70299089371c043b96"
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StartRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-rx-norm-inference-job.html) in *AWS CLI Command Reference*.
### `start-snomedct-inference-job`
The following code example shows how to use `start-snomedct-inference-job`.
**AWS CLI**
**To start an SNOMED CT inference job**
The following `start-snomedct-inference-job` example starts a SNOMED CT inference batch analysis job.
```
aws comprehendmedical start-snomedct-inference-job \
--input-data-config "S3Bucket=comp-med-input" \
--output-data-config "S3Bucket=comp-med-output" \
--data-access-role-arn arn:aws:iam::867139942017:role/ComprehendMedicalBatchProcessingRole \
--language-code en
```
Output:
```
{
"JobId": "dg7289877365fc70299089371c043b96"
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StartSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-snomedct-inference-job.html) in *AWS CLI Command Reference*.
### `stop-entities-detection-v2-job`
The following code example shows how to use `stop-entities-detection-v2-job`.
**AWS CLI**
**To stop an entity detection job**
The following `stop-entities-detection-v2-job` example stops an asynchronous entity detection job.
```
aws comprehendmedical stop-entities-detection-v2-job \
--job-id "ab9887877365fe70299089371c043b96"
```
Output:
```
{
"JobId": "ab9887877365fe70299089371c043b96"
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StopEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-entities-detection-v2-job.html) in *AWS CLI Command Reference*.
### `stop-icd10-cm-inference-job`
The following code example shows how to use `stop-icd10-cm-inference-job`.
**AWS CLI**
**To stop an ICD-10-CM inference job**
The following `stop-icd10-cm-inference-job` example stops an ICD-10-CM inference batch analysis job.
```
aws comprehendmedical stop-icd10-cm-inference-job \
--job-id "4750034166536cdb52ffa3295a1b00a3"
```
Output:
```
{
"JobId": "ef7289877365fc70299089371c043b96",
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StopIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-icd10-cm-inference-job.html) in *AWS CLI Command Reference*.
### `stop-phi-detection-job`
The following code example shows how to use `stop-phi-detection-job`.
**AWS CLI**
**To stop a protected health information (PHI) detection job**
The following `stop-phi-detection-job` example stops an asynchronous protected health information (PHI) detection job.
```
aws comprehendmedical stop-phi-detection-job \
--job-id "4750034166536cdb52ffa3295a1b00a3"
```
Output:
```
{
"JobId": "ab9887877365fe70299089371c043b96"
}
```
For more information, see [Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StopPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-phi-detection-job.html) in *AWS CLI Command Reference*.
### `stop-rx-norm-inference-job`
The following code example shows how to use `stop-rx-norm-inference-job`.
**AWS CLI**
**To stop an RxNorm inference job**
The following `stop-rx-norm-inference-job` example stops an ICD-10-CM inference batch analysis job.
```
aws comprehendmedical stop-rx-norm-inference-job \
--job-id "eg8199877365fc70299089371c043b96"
```
Output:
```
{
"JobId": "eg8199877365fc70299089371c043b96",
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StopRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-rx-norm-inference-job.html) in *AWS CLI Command Reference*.
### `stop-snomedct-inference-job`
The following code example shows how to use `stop-snomedct-inference-job`.
**AWS CLI**
**To stop a SNOMED CT inference job**
The following `stop-snomedct-inference-job` example stops a SNOMED CT inference batch analysis job.
```
aws comprehendmedical stop-snomedct-inference-job \
--job-id "8750034166436cdb52ffa3295a1b00a1"
```
Output:
```
{
"JobId": "8750034166436cdb52ffa3295a1b00a1",
}
```
For more information, see [Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html) in the *Amazon Comprehend Medical Developer Guide*.
+ For API details, see [StopSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-snomedct-inference-job.html) in *AWS CLI Command Reference*.
# AWS Config examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS Config.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `delete-config-rule`
The following code example shows how to use `delete-config-rule`.
**AWS CLI**
**To delete an AWS Config rule**
The following command deletes an AWS Config rule named `MyConfigRule`:
```
aws configservice delete-config-rule --config-rule-name MyConfigRule
```
+ For API details, see [DeleteConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-config-rule.html) in *AWS CLI Command Reference*.
### `delete-delivery-channel`
The following code example shows how to use `delete-delivery-channel`.
**AWS CLI**
**To delete a delivery channel**
The following command deletes the default delivery channel:
```
aws configservice delete-delivery-channel --delivery-channel-name default
```
+ For API details, see [DeleteDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-delivery-channel.html) in *AWS CLI Command Reference*.
### `delete-evaluation-results`
The following code example shows how to use `delete-evaluation-results`.
**AWS CLI**
**To manually delete evaluation results**
The following command deletes the current evaluation results for the AWS managed rule s3-bucket-versioning-enabled:
```
aws configservice delete-evaluation-results --config-rule-name s3-bucket-versioning-enabled
```
+ For API details, see [DeleteEvaluationResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-evaluation-results.html) in *AWS CLI Command Reference*.
### `deliver-config-snapshot`
The following code example shows how to use `deliver-config-snapshot`.
**AWS CLI**
**To deliver a configuration snapshot**
The following command delivers a configuration snapshot to the Amazon S3 bucket that belongs to the default delivery channel:
```
aws configservice deliver-config-snapshot --delivery-channel-name default
```
Output:
```
{
"configSnapshotId": "d0333b00-a683-44af-921e-examplefb794"
}
```
+ For API details, see [DeliverConfigSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/deliver-config-snapshot.html) in *AWS CLI Command Reference*.
### `describe-compliance-by-config-rule`
The following code example shows how to use `describe-compliance-by-config-rule`.
**AWS CLI**
**To get compliance information for your AWS Config rules**
The following command returns compliance information for each AWS Config rule that is violated by one or more AWS resources:
```
aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT
```
In the output, the value for each `CappedCount` attribute indicates how many resources do not comply with the related rule. For example, the following output indicates that 3 resources do not comply with the rule named `InstanceTypesAreT2micro`.
Output:
```
{
"ComplianceByConfigRules": [
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "InstanceTypesAreT2micro"
},
{
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 10,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
},
"ConfigRuleName": "RequiredTagsForVolumes"
}
]
}
```
+ For API details, see [DescribeComplianceByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-config-rule.html) in *AWS CLI Command Reference*.
### `describe-compliance-by-resource`
The following code example shows how to use `describe-compliance-by-resource`.
**AWS CLI**
**To get compliance information for your AWS resources**
The following command returns compliance information for each EC2 instance that is recorded by AWS Config and that violates one or more rules:
```
aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT
```
In the output, the value for each `CappedCount` attribute indicates how many rules the resource violates. For example, the following output indicates that instance `i-1a2b3c4d` violates 2 rules.
Output:
```
{
"ComplianceByResources": [
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 2,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
},
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d ",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
}
]
}
```
+ For API details, see [DescribeComplianceByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-resource.html) in *AWS CLI Command Reference*.
### `describe-config-rule-evaluation-status`
The following code example shows how to use `describe-config-rule-evaluation-status`.
**AWS CLI**
**To get status information for an AWS Config rule**
The following command returns the status information for an AWS Config rule named `MyConfigRule`:
```
aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule
```
Output:
```
{
"ConfigRulesEvaluationStatus": [
{
"ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
"FirstActivatedTime": 1450311703.844,
"ConfigRuleId": "config-rule-abcdef",
"LastSuccessfulInvocationTime": 1450314643.156,
"ConfigRuleName": "MyConfigRule"
}
]
}
```
+ For API details, see [DescribeConfigRuleEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rule-evaluation-status.html) in *AWS CLI Command Reference*.
### `describe-config-rules`
The following code example shows how to use `describe-config-rules`.
**AWS CLI**
**To get details for an AWS Config rule**
The following command returns details for an AWS Config rule named `InstanceTypesAreT2micro`:
```
aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro
```
Output:
```
{
"ConfigRules": [
{
"ConfigRuleState": "ACTIVE",
"Description": "Evaluates whether EC2 instances are the t2.micro type.",
"ConfigRuleName": "InstanceTypesAreT2micro",
"ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
"Source": {
"Owner": "CUSTOM_LAMBDA",
"SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
"SourceDetails": [
{
"EventSource": "aws.config",
"MessageType": "ConfigurationItemChangeNotification"
}
]
},
"InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"ConfigRuleId": "config-rule-abcdef"
}
]
}
```
+ For API details, see [DescribeConfigRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rules.html) in *AWS CLI Command Reference*.
### `describe-configuration-recorder-status`
The following code example shows how to use `describe-configuration-recorder-status`.
**AWS CLI**
**To get status information for the configuration recorder**
The following command returns the status of the default configuration recorder:
```
aws configservice describe-configuration-recorder-status
```
Output:
```
{
"ConfigurationRecordersStatus": [
{
"name": "default",
"lastStatus": "SUCCESS",
"recording": true,
"lastStatusChangeTime": 1452193834.344,
"lastStartTime": 1441039997.819,
"lastStopTime": 1441039992.835
}
]
}
```
+ For API details, see [DescribeConfigurationRecorderStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorder-status.html) in *AWS CLI Command Reference*.
### `describe-configuration-recorders`
The following code example shows how to use `describe-configuration-recorders`.
**AWS CLI**
**To get details about the configuration recorder**
The following command returns details about the default configuration recorder:
```
aws configservice describe-configuration-recorders
```
Output:
```
{
"ConfigurationRecorders": [
{
"recordingGroup": {
"allSupported": true,
"resourceTypes": [],
"includeGlobalResourceTypes": true
},
"roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6",
"name": "default"
}
]
}
```
+ For API details, see [DescribeConfigurationRecorders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorders.html) in *AWS CLI Command Reference*.
### `describe-delivery-channel-status`
The following code example shows how to use `describe-delivery-channel-status`.
**AWS CLI**
**To get status information for the delivery channel**
The following command returns the status of the delivery channel:
```
aws configservice describe-delivery-channel-status
```
Output:
```
{
"DeliveryChannelsStatus": [
{
"configStreamDeliveryInfo": {
"lastStatusChangeTime": 1452193834.381,
"lastStatus": "SUCCESS"
},
"configHistoryDeliveryInfo": {
"lastSuccessfulTime": 1450317838.412,
"lastStatus": "SUCCESS",
"lastAttemptTime": 1450317838.412
},
"configSnapshotDeliveryInfo": {
"lastSuccessfulTime": 1452185597.094,
"lastStatus": "SUCCESS",
"lastAttemptTime": 1452185597.094
},
"name": "default"
}
]
}
```
+ For API details, see [DescribeDeliveryChannelStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channel-status.html) in *AWS CLI Command Reference*.
### `describe-delivery-channels`
The following code example shows how to use `describe-delivery-channels`.
**AWS CLI**
**To get details about the delivery channel**
The following command returns details about the delivery channel:
```
aws configservice describe-delivery-channels
```
Output:
```
{
"DeliveryChannels": [
{
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"name": "default",
"s3BucketName": "config-bucket-123456789012"
}
]
}
```
+ For API details, see [DescribeDeliveryChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channels.html) in *AWS CLI Command Reference*.
### `get-compliance-details-by-config-rule`
The following code example shows how to use `get-compliance-details-by-config-rule`.
**AWS CLI**
**To get the evaluation results for an AWS Config rule**
The following command returns the evaluation results for all of the resources that don't comply with an AWS Config rule named `InstanceTypesAreT2micro`:
```
aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT
```
Output:
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.18,
"ConfigRuleInvokedTime": 1450314642.902,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-3a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.346,
"ConfigRuleInvokedTime": 1450314643.124,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ For API details, see [GetComplianceDetailsByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-config-rule.html) in *AWS CLI Command Reference*.
### `get-compliance-details-by-resource`
The following code example shows how to use `get-compliance-details-by-resource`.
**AWS CLI**
**To get the evaluation results for an AWS resource**
The following command returns the evaluation results for each rule with which the EC2 instance `i-1a2b3c4d` does not comply:
```
aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT
```
Output:
```
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.288,
"ConfigRuleInvokedTime": 1450314643.034,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "RequiredTagForEC2Instances"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
}
]
}
```
+ For API details, see [GetComplianceDetailsByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-resource.html) in *AWS CLI Command Reference*.
### `get-compliance-summary-by-config-rule`
The following code example shows how to use `get-compliance-summary-by-config-rule`.
**AWS CLI**
**To get the compliance summary for your AWS Config rules**
The following command returns the number of rules that are compliant and the number that are noncompliant:
```
aws configservice get-compliance-summary-by-config-rule
```
In the output, the value for each `CappedCount` attribute indicates how many rules are compliant or noncompliant.
Output:
```
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204131.493,
"CompliantResourceCount": {
"CappedCount": 2,
"CapExceeded": false
}
}
}
```
+ For API details, see [GetComplianceSummaryByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-config-rule.html) in *AWS CLI Command Reference*.
### `get-compliance-summary-by-resource-type`
The following code example shows how to use `get-compliance-summary-by-resource-type`.
**AWS CLI**
**To get the compliance summary for all resource types**
The following command returns the number of AWS resources that are noncompliant and the number that are compliant:
```
aws configservice get-compliance-summary-by-resource-type
```
In the output, the value for each `CappedCount` attribute indicates how many resources are compliant or noncompliant.
Output:
```
{
"ComplianceSummariesByResourceType": [
{
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 16,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1453237464.543,
"CompliantResourceCount": {
"CappedCount": 10,
"CapExceeded": false
}
}
}
]
}
```
**To get the compliance summary for a specific resource type**
The following command returns the number of EC2 instances that are noncompliant and the number that are compliant:
```
aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance
```
In the output, the value for each `CappedCount` attribute indicates how many resources are compliant or noncompliant.
Output:
```
{
"ComplianceSummariesByResourceType": [
{
"ResourceType": "AWS::EC2::Instance",
"ComplianceSummary": {
"NonCompliantResourceCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceSummaryTimestamp": 1452204923.518,
"CompliantResourceCount": {
"CappedCount": 7,
"CapExceeded": false
}
}
}
]
}
```
+ For API details, see [GetComplianceSummaryByResourceType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-resource-type.html) in *AWS CLI Command Reference*.
### `get-resource-config-history`
The following code example shows how to use `get-resource-config-history`.
**AWS CLI**
**To get the configuration history of an AWS resource**
The following command returns a list of configuration items for an EC2 instance with an ID of `i-1a2b3c4d`:
```
aws configservice get-resource-config-history --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d
```
+ For API details, see [GetResourceConfigHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-resource-config-history.html) in *AWS CLI Command Reference*.
### `get-status`
The following code example shows how to use `get-status`.
**AWS CLI**
**To get the status for AWS Config**
The following command returns the status of the delivery channel and configuration recorder:
```
aws configservice get-status
```
Output:
```
Configuration Recorders:
name: default
recorder: ON
last status: SUCCESS
Delivery Channels:
name: default
last stream delivery status: SUCCESS
last history delivery status: SUCCESS
last snapshot delivery status: SUCCESS
```
+ For API details, see [GetStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-status.html) in *AWS CLI Command Reference*.
### `list-discovered-resources`
The following code example shows how to use `list-discovered-resources`.
**AWS CLI**
**To list resources that AWS Config has discovered**
The following command lists the EC2 instances that AWS Config has discovered:
```
aws configservice list-discovered-resources --resource-type AWS::EC2::Instance
```
Output:
```
{
"resourceIdentifiers": [
{
"resourceType": "AWS::EC2::Instance",
"resourceId": "i-1a2b3c4d"
},
{
"resourceType": "AWS::EC2::Instance",
"resourceId": "i-2a2b3c4d"
},
{
"resourceType": "AWS::EC2::Instance",
"resourceId": "i-3a2b3c4d"
}
]
}
```
+ For API details, see [ListDiscoveredResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/list-discovered-resources.html) in *AWS CLI Command Reference*.
### `put-config-rule`
The following code example shows how to use `put-config-rule`.
**AWS CLI**
**To add an AWS managed Config rule**
The following command provides JSON code to add an AWS managed Config rule:
```
aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json
```
`RequiredTagsForEC2Instances.json` is a JSON file that contains the rule configuration:
```
{
"ConfigRuleName": "RequiredTagsForEC2Instances",
"Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "AWS",
"SourceIdentifier": "REQUIRED_TAGS"
},
"InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}"
}
```
For the `ComplianceResourceTypes` attribute, this JSON code limits the scope to resources of the `AWS::EC2::Instance` type, so AWS Config will evaluate only EC2 instances against the rule. Because the rule is a managed rule, the `Owner` attribute is set to `AWS`, and the `SourceIdentifier` attribute is set to the rule identifier, `REQUIRED_TAGS`. For the `InputParameters` attribute, the tag keys that the rule requires, `CostCenter` and `Owner`, are specified.
If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the describe-config-rules command, and specify the rule name.
**To add a customer managed Config rule**
The following command provides JSON code to add a customer managed Config rule:
```
aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json
```
`InstanceTypesAreT2micro.json` is a JSON file that contains the rule configuration:
```
{
"ConfigRuleName": "InstanceTypesAreT2micro",
"Description": "Evaluates whether EC2 instances are the t2.micro type.",
"Scope": {
"ComplianceResourceTypes": [
"AWS::EC2::Instance"
]
},
"Source": {
"Owner": "CUSTOM_LAMBDA",
"SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck",
"SourceDetails": [
{
"EventSource": "aws.config",
"MessageType": "ConfigurationItemChangeNotification"
}
]
},
"InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}"
}
```
For the `ComplianceResourceTypes` attribute, this JSON code limits the scope to resources of the `AWS::EC2::Instance` type, so AWS Config will evaluate only EC2 instances against the rule. Because this rule is a customer managed rule, the `Owner` attribute is set to `CUSTOM_LAMBDA`, and the `SourceIdentifier` attribute is set to the ARN of the AWS Lambda function. The `SourceDetails` object is required. The parameters that are specified for the `InputParameters` attribute are passed to the AWS Lambda function when AWS Config invokes it to evaluate resources against the rule.
If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the describe-config-rules command, and specify the rule name.
+ For API details, see [PutConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-config-rule.html) in *AWS CLI Command Reference*.
### `put-configuration-recorder`
The following code example shows how to use `put-configuration-recorder`.
**AWS CLI**
**Example 1: To record all supported resources**
The following command creates a configuration recorder that tracks changes to all supported resource types, including global resource types:
```
aws configservice put-configuration-recorder \
--configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \
--recording-group allSupported=true,includeGlobalResourceTypes=true
```
If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the describe-configuration-recorders command.
**Example 2: To record specific types of resources**
The following command creates a configuration recorder that tracks changes to only those types of resources that are specified in the JSON file for the --recording-group option:
```
aws configservice put-configuration-recorder \
--configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \
--recording-group file://recordingGroup.json
```
recordingGroup.json is a JSON file that specifies the types of resources that AWS Config will record:
```
{
"allSupported": false,
"includeGlobalResourceTypes": false,
"resourceTypes": [
"AWS::EC2::EIP",
"AWS::EC2::Instance",
"AWS::EC2::NetworkAcl",
"AWS::EC2::SecurityGroup",
"AWS::CloudTrail::Trail",
"AWS::EC2::Volume",
"AWS::EC2::VPC",
"AWS::IAM::User",
"AWS::IAM::Policy"
]
}
```
Before you can specify resource types for the resourceTypes key, you must set the allSupported and includeGlobalResourceTypes options to false or omit them.
If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the describe-configuration-recorders command.
**Example 3: To select all supported resources excluding specific types of resources**
The following command creates a configuration recorder that tracks changes to all current and future supported resource types excluding those types of resources that are specified in the JSON file for the --recording-group option:
```
aws configservice put-configuration-recorder \
--configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \
--recording-group file://recordingGroup.json
```
recordingGroup.json is a JSON file that specifies the types of resources that AWS Config will record:
```
{
"allSupported": false,
"exclusionByResourceTypes": {
"resourceTypes": [
"AWS::Redshift::ClusterSnapshot",
"AWS::RDS::DBClusterSnapshot",
"AWS::CloudFront::StreamingDistribution"
]
},
"includeGlobalResourceTypes": false,
"recordingStrategy": {
"useOnly": "EXCLUSION_BY_RESOURCE_TYPES"
},
}
```
Before you can specify resource types to excluding from recording: 1) You must set the allSupported and includeGlobalResourceTypes options to false or omit them, and 2) You must set the useOnly field of RecordingStrategy to EXCLUSION\$1BY\$1RESOURCE\$1TYPES.
If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the describe-configuration-recorders command.
+ For API details, see [PutConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-configuration-recorder.html) in *AWS CLI Command Reference*.
### `put-delivery-channel`
The following code example shows how to use `put-delivery-channel`.
**AWS CLI**
**To create a delivery channel**
The following command provides the settings for the delivery channel as JSON code:
```
aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json
```
The `deliveryChannel.json` file specifies the delivery channel attributes:
```
{
"name": "default",
"s3BucketName": "config-bucket-123456789012",
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"configSnapshotDeliveryProperties": {
"deliveryFrequency": "Twelve_Hours"
}
}
```
This example sets the following attributes:
`name` - The name of the delivery channel. By default, AWS Config assigns the name `default` to a new delivery channel.You cannot update the delivery channel name with the `put-delivery-channel` command. For the steps to change the name, see Renaming the Delivery Channel.`s3BucketName` - The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket.
`snsTopicARN` - The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic.
`configSnapshotDeliveryProperties` - Contains the `deliveryFrequency` attribute, which sets how often AWS Config delivers configuration snapshots and how often it invokes evaluations for periodic Config rules.
If the command succeeds, AWS Config returns no output. To verify the settings of your delivery channel, run the describe-delivery-channels command.
+ For API details, see [PutDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-delivery-channel.html) in *AWS CLI Command Reference*.
### `start-config-rules-evaluation`
The following code example shows how to use `start-config-rules-evaluation`.
**AWS CLI**
**To run an on-demand evaluation for AWS Config rules**
The following command starts an evaluation for two AWS managed rules:
```
aws configservice start-config-rules-evaluation --config-rule-names s3-bucket-versioning-enabled cloudtrail-enabled
```
+ For API details, see [StartConfigRulesEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-config-rules-evaluation.html) in *AWS CLI Command Reference*.
### `start-configuration-recorder`
The following code example shows how to use `start-configuration-recorder`.
**AWS CLI**
**To start the configuration recorder**
The following command starts the default configuration recorder:
```
aws configservice start-configuration-recorder --configuration-recorder-name default
```
If the command succeeds, AWS Config returns no output. To verify that AWS Config is recording your resources, run the get-status command.
+ For API details, see [StartConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-configuration-recorder.html) in *AWS CLI Command Reference*.
### `stop-configuration-recorder`
The following code example shows how to use `stop-configuration-recorder`.
**AWS CLI**
**To stop the configuration recorder**
The following command stops the default configuration recorder:
```
aws configservice stop-configuration-recorder --configuration-recorder-name default
```
If the command succeeds, AWS Config returns no output. To verify that AWS Config is not recording your resources, run the get-status command.
+ For API details, see [StopConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/stop-configuration-recorder.html) in *AWS CLI Command Reference*.
### `subscribe`
The following code example shows how to use `subscribe`.
**AWS CLI**
**To subscribe to AWS Config**
The following command creates the default delivery channel and configuration recorder. The command also specifies the Amazon S3 bucket and Amazon SNS topic to which AWS Config will deliver configuration information:
```
aws configservice subscribe --s3-bucket config-bucket-123456789012 --sns-topic arn:aws:sns:us-east-1:123456789012:config-topic --iam-role arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6
```
Output:
```
Using existing S3 bucket: config-bucket-123456789012
Using existing SNS topic: arn:aws:sns:us-east-1:123456789012:config-topic
Subscribe succeeded:
Configuration Recorders: [
{
"recordingGroup": {
"allSupported": true,
"resourceTypes": [],
"includeGlobalResourceTypes": false
},
"roleARN": "arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6",
"name": "default"
}
]
Delivery Channels: [
{
"snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
"name": "default",
"s3BucketName": "config-bucket-123456789012"
}
]
```
+ For API details, see [Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/subscribe.html) in *AWS CLI Command Reference*.
# Amazon Connect examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Connect.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-user`
The following code example shows how to use `create-user`.
**AWS CLI**
**To create a user**
The following `create-user` example adds a user with the specified attributes to the specified Amazon Connect instance.
```
aws connect create-user \
--username Mary \
--password Pass@Word1 \
--identity-info FirstName=Mary,LastName=Major \
--phone-config PhoneType=DESK_PHONE,AutoAccept=true,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+15555551212 \
--security-profile-id 12345678-1111-2222-aaaa-a1b2c3d4f5g7 \
--routing-profile-id 87654321-9999-3434-abcd-x1y2z3a1b2c3 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"UserId": "87654321-2222-1234-1234-111234567891",
"UserArn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent/87654321-2222-1234-1234-111234567891"
}
```
For more information, see [Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/create-user.html) in *AWS CLI Command Reference*.
### `delete-user`
The following code example shows how to use `delete-user`.
**AWS CLI**
**To delete a user**
The following `delete-user` example deletes the specified user from the specified Amazon Connect instance.
```
aws connect delete-user \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--user-id 87654321-2222-1234-1234-111234567891
```
This command produces no output.
For more information, see [Manage Users](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/delete-user.html) in *AWS CLI Command Reference*.
### `describe-user-hierarchy-group`
The following code example shows how to use `describe-user-hierarchy-group`.
**AWS CLI**
**To display the details for a hierarchy group**
The following `describe-user-hierarchy-group` example displays the details for the specified Amazon Connect hierarchy group.
```
aws connect describe-user-hierarchy-group \
--hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"HierarchyGroup": {
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/12345678-1111-2222-800e-a2b3c4d5f6g7",
"Name": "Example Corporation",
"LevelId": "1",
"HierarchyPath": {
"LevelOne": {
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group/abcdefgh-3333-4444-8af3-201123456789",
"Name": "Example Corporation"
}
}
}
}
```
For more information, see [Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [DescribeUserHierarchyGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-group.html) in *AWS CLI Command Reference*.
### `describe-user-hierarchy-structure`
The following code example shows how to use `describe-user-hierarchy-structure`.
**AWS CLI**
**To display the details for a hierarchy structure**
The following `describe-user-hierarchy-structure` example displays the details for the hierarchy structure for the specified Amazon Connect instance.
```
aws connect describe-user-hierarchy-group \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"HierarchyStructure": {
"LevelOne": {
"Id": "12345678-1111-2222-800e-aaabbb555gg",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/1",
"Name": "Corporation"
},
"LevelTwo": {
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/2",
"Name": "Services Division"
},
"LevelThree": {
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/agent-group-level/3",
"Name": "EU Site"
}
}
}
```
For more information, see [Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [DescribeUserHierarchyStructure](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-structure.html) in *AWS CLI Command Reference*.
### `describe-user`
The following code example shows how to use `describe-user`.
**AWS CLI**
**To display the details for a user**
The following `describe-user` example displays the details for the specified Amazon Connect user.
```
aws connect describe-user \
--user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60
--instance-id 40c83b68-ea62-414c-97bb-d018e39e158e
```
Output:
```
{
"User": {
"Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
"Username": "Jane",
"IdentityInfo": {
"FirstName": "Jane",
"LastName": "Doe",
"Email": "example.com"
},
"PhoneConfig": {
"PhoneType": "SOFT_PHONE",
"AutoAccept": false,
"AfterContactWorkTimeLimit": 0,
"DeskPhoneNumber": ""
},
"DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658",
"SecurityProfileIds": [
"b6f85a42-1dc5-443b-b621-de0abf70c9cf"
],
"RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5",
"Tags": {}
}
}
```
For more information, see [Manage Users](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user.html) in *AWS CLI Command Reference*.
### `get-contact-attributes`
The following code example shows how to use `get-contact-attributes`.
**AWS CLI**
**To retrieve the attributes for a contact**
The following `get-contact-attributes` example retrieves the attributes that were set for the specified Amazon Connect contact.
```
aws connect get-contact-attributes \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7
```
Output:
```
{
"Attributes": {
"greetingPlayed": "true"
}
}
```
For more information, see [Use Amazon Connect Contact Attributes](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [GetContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/get-contact-attributes.html) in *AWS CLI Command Reference*.
### `list-contact-flows`
The following code example shows how to use `list-contact-flows`.
**AWS CLI**
**To list the contact flows in an instance**
The following `list-contact-flows` example lists the contact flows in the specified Amazon Connect instance.
```
aws connect list-contact-flows \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"ContactFlowSummaryList": [
{
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/12345678-1111-2222-800e-a2b3c4d5f6g7",
"Name": "Default queue transfer",
"ContactFlowType": "QUEUE_TRANSFER"
},
{
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/87654321-2222-3333-ac99-123456789102",
"Name": "Default agent hold",
"ContactFlowType": "AGENT_HOLD"
},
{
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/contact-flow/abcdefgh-3333-4444-8af3-201123456789",
"Name": "Default customer hold",
"ContactFlowType": "CUSTOMER_HOLD"
},
]
}
```
For more information, see [Create Amazon Connect Contact Flows](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-flows.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListContactFlows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-contact-flows.html) in *AWS CLI Command Reference*.
### `list-hours-of-operations`
The following code example shows how to use `list-hours-of-operations`.
**AWS CLI**
**To list the hours of operation in an instance**
The following `list-hours-of-operations` example lists the hours of operations for the specified Amazon Connect instance.
```
aws connect list-hours-of-operations \
--instance-id 40c83b68-ea62-414c-97bb-d018e39e158e
```
Output:
```
{
"HoursOfOperationSummaryList": [
{
"Id": "d69f1f84-7457-4924-8fbe-e64875546259",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/operating-hours/d69f1f84-7457-4924-8fbe-e64875546259",
"Name": "Basic Hours"
}
]
}
```
For more information, see [Set the Hours of Operation for a Queue](https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListHoursOfOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-hours-of-operations.html) in *AWS CLI Command Reference*.
### `list-phone-numbers`
The following code example shows how to use `list-phone-numbers`.
**AWS CLI**
**To list the phone numbers in an instance**
The following `list-phone-numbers` example lists the phone numbers in the specified Amazon Connect instance.
```
aws connect list-phone-numbers \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"PhoneNumberSummaryList": [
{
"Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE",
"PhoneNumber": "+17065551212",
"PhoneNumberType": "DID",
"PhoneNumberCountryCode": "US"
},
{
"Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE",
"PhoneNumber": "+18555551212",
"PhoneNumberType": "TOLL_FREE",
"PhoneNumberCountryCode": "US"
}
]
}
```
For more information, see [Set Up Phone Numbers for Your Contact Center](https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-phone-numbers.html) in *AWS CLI Command Reference*.
### `list-queues`
The following code example shows how to use `list-queues`.
**AWS CLI**
**To list the queues in an instance**
The following `list-queues` example lists the queues in the specified Amazon Connect instance.
```
aws connect list-queues \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"QueueSummaryList": [
{
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/12345678-1111-2222-800e-a2b3c4d5f6g7",
"QueueType": "AGENT"
},
{
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/87654321-2222-3333-ac99-123456789102",
"QueueType": "AGENT"
},
{
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/agent/abcdefgh-3333-4444-8af3-201123456789",
"QueueType": "AGENT"
},
{
"Id": "hgfedcba-4444-5555-a31f-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/queue/hgfedcba-4444-5555-a31f-123456789102",
"Name": "BasicQueue",
"QueueType": "STANDARD"
},
]
}
```
For more information, see [Create a Queue](https://docs.aws.amazon.com/connect/latest/adminguide/create-queue.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-queues.html) in *AWS CLI Command Reference*.
### `list-routing-profiles`
The following code example shows how to use `list-routing-profiles`.
**AWS CLI**
**To list the routing profiles in an instance**
The following `list-routing-profiles` example lists the routing profiles in the specified Amazon Connect instance.
```
aws connect list-routing-profiles \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"RoutingProfileSummaryList": [
{
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/routing-profile/12345678-1111-2222-800e-a2b3c4d5f6g7",
"Name": "Basic Routing Profile"
},
]
}
```
For more information, see [Create a Routing Profile](https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListRoutingProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-routing-profiles.html) in *AWS CLI Command Reference*.
### `list-security-profiles`
The following code example shows how to use `list-security-profiles`.
**AWS CLI**
**To list the security profiles in an instance**
The following `list-security-profiles` example lists the security profiles in the specified Amazon Connect instance.
```
aws connect list-security-profiles \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
Output:
```
{
"SecurityProfileSummaryList": [
{
"Id": "12345678-1111-2222-800e-a2b3c4d5f6g7",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-a2b3c4d5f6g7",
"Name": "CallCenterManager"
},
{
"Id": "87654321-2222-3333-ac99-123456789102",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/87654321-2222-3333-ac99-123456789102",
"Name": "QualityAnalyst"
},
{
"Id": "abcdefgh-3333-4444-8af3-201123456789",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/abcdefgh-3333-4444-8af3-201123456789",
"Name": "Agent"
},
{
"Id": "12345678-1111-2222-800e-x2y3c4d5fzzzz",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/security-profile/12345678-1111-2222-800e-x2y3c4d5fzzzz",
"Name": "Admin"
}
]
}
```
For more information, see [Assign Permissions: Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-security-profiles.html) in *AWS CLI Command Reference*.
### `list-user-hierarchy-groups`
The following code example shows how to use `list-user-hierarchy-groups`.
**AWS CLI**
**To list the user hierarchy groups in an instance**
The following `list-user-hierarchy-groups` example lists the user hierarchy groups in the specified Amazon Connect instance.
```
aws connect list-user-hierarchy-groups \
--instance-id 40c83b68-ea62-414c-97bb-d018e39e158e
```
Output:
```
{
"UserHierarchyGroupSummaryList": [
{
"Id": "0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent-group/0e2f6d1d-b3ca-494b-8dbc-ba81d9f8182a",
"Name": "Example Corporation"
},
]
}
```
For more information, see [Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListUserHierarchyGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-user-hierarchy-groups.html) in *AWS CLI Command Reference*.
### `list-users`
The following code example shows how to use `list-users`.
**AWS CLI**
**To list the user hierarchy groups in an instance**
The following `list-users` example lists the users in the specified Amazon Connect instance.
```
aws connect list-users \
--instance-id 40c83b68-ea62-414c-97bb-d018e39e158e
```
Output:
```
{
"UserSummaryList": [
{
"Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
"Username": "Jane"
},
{
"Id": "46f0c67c-3fc7-4806-ac99-403798788c14",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/46f0c67c-3fc7-4806-ac99-403798788c14",
"Username": "Paulo"
},
{
"Id": "55a83578-95e1-4710-8af3-2b7afe310e48",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/55a83578-95e1-4710-8af3-2b7afe310e48",
"Username": "JohnD"
},
{
"Id": "703e27b5-c9f0-4f1f-a239-64ccbb160125",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/703e27b5-c9f0-4f1f-a239-64ccbb160125",
"Username": "JohnS"
}
]
}
```
For more information, see [Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-users.html) in *AWS CLI Command Reference*.
### `update-contact-attributes`
The following code example shows how to use `update-contact-attributes`.
**AWS CLI**
**To update a contact's attribute**
The following `update-contact-attributes` example updates the `greetingPlayed` attribute for the specified Amazon Connect user.
```
aws connect update-contact-attributes \
--initial-contact-id 11111111-2222-3333-4444-12345678910 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--attributes greetingPlayed=false
```
This command produces no output.
For more information, see [Use Amazon Connect Contact Attributes](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-contact-attributes.html) in *AWS CLI Command Reference*.
### `update-user-hierarchy`
The following code example shows how to use `update-user-hierarchy`.
**AWS CLI**
**To update a user's hierarchy**
The following `update-user-hierarchy` example updates the agent hierarchy for the specified Amazon Connect user.
```
aws connect update-user-hierarchy \
--hierarchy-group-id 12345678-a1b2-c3d4-e5f6-123456789abc \
--user-id 87654321-2222-1234-1234-111234567891 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
This command produces no output.
For more information, see [Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateUserHierarchy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-hierarchy.html) in *AWS CLI Command Reference*.
### `update-user-identity-info`
The following code example shows how to use `update-user-identity-info`.
**AWS CLI**
**To update a user's identity information**
The following `update-user-identity-info` example updates the identity information for the specified Amazon Connect user.
```
aws connect update-user-identity-info \
--identity-info FirstName=Mary,LastName=Major,Email=marym@example.com \
--user-id 87654321-2222-1234-1234-111234567891 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
This command produces no output.
For more information, see [Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateUserIdentityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-identity-info.html) in *AWS CLI Command Reference*.
### `update-user-phone-config`
The following code example shows how to use `update-user-phone-config`.
**AWS CLI**
**To update a user's phone configuration**
The following `update-user-phone-config` example updates the phone configuration for the specified user.
```
aws connect update-user-phone-config \
--phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \
--user-id 12345678-4444-3333-2222-111122223333 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
This command produces no output.
For more information, see [Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateUserPhoneConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-phone-config.html) in *AWS CLI Command Reference*.
### `update-user-routing-profile`
The following code example shows how to use `update-user-routing-profile`.
**AWS CLI**
**To update a user's routing profile**
The following `update-user-routing-profile` example updates the routing profile for the specified Amazon Connect user.
```
aws connect update-user-routing-profile \
--routing-profile-id 12345678-1111-3333-2222-4444EXAMPLE \
--user-id 87654321-2222-1234-1234-111234567891 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
This command produces no output.
For more information, see [Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateUserRoutingProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-routing-profile.html) in *AWS CLI Command Reference*.
### `update-user-security-profiles`
The following code example shows how to use `update-user-security-profiles`.
**AWS CLI**
**To update a user's security profiles**
The following `update-user-security-profiles` example updates the security profile for the specified Amazon Connect user.
```
aws connect update-user-security-profiles \
--security-profile-ids 12345678-1234-1234-1234-1234567892111 \
--user-id 87654321-2222-1234-1234-111234567891 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```
This command produces no output.
For more information, see [Assign Permissions: Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*.
+ For API details, see [UpdateUserSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-security-profiles.html) in *AWS CLI Command Reference*.
# AWS Cost and Usage Report examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS Cost and Usage Report.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `delete-report-definition`
The following code example shows how to use `delete-report-definition`.
**AWS CLI**
**To delete an AWS Cost and Usage Report**
This example deletes an AWS Cost and Usage Report.
Command:
```
aws cur --region us-east-1 delete-report-definition --report-name "ExampleReport"
```
+ For API details, see [DeleteReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/delete-report-definition.html) in *AWS CLI Command Reference*.
### `describe-report-definitions`
The following code example shows how to use `describe-report-definitions`.
**AWS CLI**
**To retrieve a list of AWS Cost and Usage Reports**
This example describes a list of AWS Cost and Usage Reports owned by an account.
Command:
```
aws cur --region us-east-1 describe-report-definitions --max-items 5
```
Output:
```
{
"ReportDefinitions": [
{
"ReportName": "ExampleReport",
"Compression": "ZIP",
"S3Region": "us-east-1",
"Format": "textORcsv",
"S3Prefix": "exampleprefix",
"S3Bucket": "example-s3-bucket",
"TimeUnit": "DAILY",
"AdditionalArtifacts": [
"REDSHIFT",
"QUICKSIGHT"
],
"AdditionalSchemaElements": [
"RESOURCES"
]
}
]
}
```
+ For API details, see [DescribeReportDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/describe-report-definitions.html) in *AWS CLI Command Reference*.
### `put-report-definition`
The following code example shows how to use `put-report-definition`.
**AWS CLI**
**To create an AWS Cost and Usage Reports**
The following `put-report-definition` example creates a daily AWS Cost and Usage Report that you can upload into Amazon Redshift or Amazon QuickSight.
```
aws cur put-report-definition --report-definition file://report-definition.json
```
Contents of `report-definition.json`:
```
{
"ReportName": "ExampleReport",
"TimeUnit": "DAILY",
"Format": "textORcsv",
"Compression": "ZIP",
"AdditionalSchemaElements": [
"RESOURCES"
],
"S3Bucket": "example-s3-bucket",
"S3Prefix": "exampleprefix",
"S3Region": "us-east-1",
"AdditionalArtifacts": [
"REDSHIFT",
"QUICKSIGHT"
]
}
```
+ For API details, see [PutReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/put-report-definition.html) in *AWS CLI Command Reference*.
# Cost Explorer Service examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Cost Explorer Service.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `get-cost-and-usage`
The following code example shows how to use `get-cost-and-usage`.
**AWS CLI**
**To retrieve the S3 usage of an account for the month of September 2017**
The following `get-cost-and-usage` example retrieves the S3 usage of an account for the month of September 2017.
```
aws ce get-cost-and-usage \
--time-period Start=2017-09-01,End=2017-10-01 \
--granularity MONTHLY \
--metrics "BlendedCost" "UnblendedCost" "UsageQuantity" \
--group-by Type=DIMENSION,Key=SERVICE Type=TAG,Key=Environment \
--filter file://filters.json
```
Contents of `filters.json`:
```
{
"Dimensions": {
"Key": "SERVICE",
"Values": [
"Amazon Simple Storage Service"
]
}
}
```
Output:
```
{
"GroupDefinitions": [
{
"Type": "DIMENSION",
"Key": "SERVICE"
},
{
"Type": "TAG",
"Key": "Environment"
}
],
"ResultsByTime": [
{
"Estimated": false,
"TimePeriod": {
"Start": "2017-09-01",
"End": "2017-10-01"
},
"Total": {},
"Groups": [
{
"Keys": [
"Amazon Simple Storage Service",
"Environment$"
],
"Metrics": {
"BlendedCost": {
"Amount": "40.3527508453",
"Unit": "USD"
},
"UnblendedCost": {
"Amount": "40.3543773134",
"Unit": "USD"
},
"UsageQuantity": {
"Amount": "9312771.098461578",
"Unit": "N/A"
}
}
},
{
"Keys": [
"Amazon Simple Storage Service",
"Environment$Dev"
],
"Metrics": {
"BlendedCost": {
"Amount": "0.2682364644",
"Unit": "USD"
},
"UnblendedCost": {
"Amount": "0.2682364644",
"Unit": "USD"
},
"UsageQuantity": {
"Amount": "22403.4395271182",
"Unit": "N/A"
}
}
}
]
}
]
}
```
+ For API details, see [GetCostAndUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-cost-and-usage.html) in *AWS CLI Command Reference*.
### `get-dimension-values`
The following code example shows how to use `get-dimension-values`.
**AWS CLI**
**To retrieve the tags for the dimension SERVICE, with a value of "Elastic"**
This example retrieves the tags for the dimension SERVICE, with a value of "Elastic" for January 01 2017 through May 18 2017.
Command:
```
aws ce get-dimension-values --search-string Elastic --time-period Start=2017-01-01,End=2017-05-18 --dimension SERVICE
```
Output:
```
{
"TotalSize": 6,
"DimensionValues": [
{
"Attributes": {},
"Value": "Amazon ElastiCache"
},
{
"Attributes": {},
"Value": "EC2 - Other"
},
{
"Attributes": {},
"Value": "Amazon Elastic Compute Cloud - Compute"
},
{
"Attributes": {},
"Value": "Amazon Elastic Load Balancing"
},
{
"Attributes": {},
"Value": "Amazon Elastic MapReduce"
},
{
"Attributes": {},
"Value": "Amazon Elasticsearch Service"
}
],
"ReturnSize": 6
}
```
+ For API details, see [GetDimensionValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-dimension-values.html) in *AWS CLI Command Reference*.
### `get-reservation-coverage`
The following code example shows how to use `get-reservation-coverage`.
**AWS CLI**
**To retrieve the reservation coverage for EC2 t2.nano instances in the us-east-1 region**
This example retrieves the reservation coverage for EC2 t2.nano instances in the us-east-1 region for July-September of 2017.
Command:
```
aws ce get-reservation-coverage --time-period Start=2017-07-01,End=2017-10-01 --group-by Type=Dimension,Key=REGION --filter file://filters.json
```
filters.json:
```
{
"And": [
{
"Dimensions": {
"Key": "INSTANCE_TYPE",
"Values": [
"t2.nano"
]
},
"Dimensions": {
"Key": "REGION",
"Values": [
"us-east-1"
]
}
}
]
}
```
Output:
```
{
"TotalSize": 6,
"DimensionValues": [
{
"Attributes": {},
"Value": "Amazon ElastiCache"
},
{
"Attributes": {},
"Value": "EC2 - Other"
},
{
"Attributes": {},
"Value": "Amazon Elastic Compute Cloud - Compute"
},
{
"Attributes": {},
"Value": "Amazon Elastic Load Balancing"
},
{
"Attributes": {},
"Value": "Amazon Elastic MapReduce"
},
{
"Attributes": {},
"Value": "Amazon Elasticsearch Service"
}
],
"ReturnSize": 6
}
```
+ For API details, see [GetReservationCoverage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-coverage.html) in *AWS CLI Command Reference*.
### `get-reservation-purchase-recommendation`
The following code example shows how to use `get-reservation-purchase-recommendation`.
**AWS CLI**
**To retrieve the reservation recommendations for Partial Upfront EC2 RIs with a three year term**
The following `get-reservation-purchase-recommendation` example retrieves recommendations for Partial Upfront EC2 instances with a three-year term, based on the last 60 days of EC2 usage.
```
aws ce get-reservation-purchase-recommendation \
--service "Amazon Redshift" \
--lookback-period-in-days SIXTY_DAYS \
--term-in-years THREE_YEARS \
--payment-option PARTIAL_UPFRONT
```
Output:
```
{
"Recommendations": [],
"Metadata": {
"GenerationTimestamp": "2018-08-08T15:20:57Z",
"RecommendationId": "00d59dde-a1ad-473f-8ff2-iexample3330b"
}
}
```
+ For API details, see [GetReservationPurchaseRecommendation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-purchase-recommendation.html) in *AWS CLI Command Reference*.
### `get-reservation-utilization`
The following code example shows how to use `get-reservation-utilization`.
**AWS CLI**
**To retrieve the reservation utilization for your account**
The following `get-reservation-utilization` example retrieves the RI utilization for all t2.nano instance types from 2018-03-01 to 2018-08-01 for the account.
```
aws ce get-reservation-utilization \
--time-period Start=2018-03-01,End=2018-08-01 \
--filter file://filters.json
```
Contents of `filters.json`:
```
{
"Dimensions": {
"Key": "INSTANCE_TYPE",
"Values": [
"t2.nano"
]
}
}
```
Output:
```
{
"Total": {
"TotalAmortizedFee": "0",
"UtilizationPercentage": "0",
"PurchasedHours": "0",
"NetRISavings": "0",
"TotalActualHours": "0",
"AmortizedRecurringFee": "0",
"UnusedHours": "0",
"TotalPotentialRISavings": "0",
"OnDemandCostOfRIHoursUsed": "0",
"AmortizedUpfrontFee": "0"
},
"UtilizationsByTime": []
}
```
+ For API details, see [GetReservationUtilization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-utilization.html) in *AWS CLI Command Reference*.
### `get-tags`
The following code example shows how to use `get-tags`.
**AWS CLI**
**To retrieve keys and values for a cost allocation tag**
This example retrieves all cost allocation tags with a key of "Project" and a value that contains "secretProject".
Command:
```
aws ce get-tags --search-string secretProject --time-period Start=2017-01-01,End=2017-05-18 --tag-key Project
```
Output:
```
{
"ReturnSize": 2,
"Tags": [
"secretProject1",
"secretProject2"
],
"TotalSize": 2
}
```
+ For API details, see [GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-tags.html) in *AWS CLI Command Reference*.
# Firehose examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Firehose.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `list-delivery-streams`
The following code example shows how to use `list-delivery-streams`.
**AWS CLI**
**To list the available delivery streams**
The following `list-delivery-streams` example lists the available delivery streams in your AWS account.
```
aws firehose list-delivery-streams
```
Output:
```
{
"DeliveryStreamNames": [
"my-stream"
],
"HasMoreDeliveryStreams": false
}
```
For more information, see [Creating an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html) in the *Amazon Kinesis Data Firehose Developer Guide*.
+ For API details, see [ListDeliveryStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/list-delivery-streams.html) in *AWS CLI Command Reference*.
### `put-record-batch`
The following code example shows how to use `put-record-batch`.
**AWS CLI**
**To write multiple records to a stream**
The following `put-record-batch` example writes three records to a stream. The data is encoded in Base64 format.
```
aws firehose put-record-batch \
--delivery-stream-name my-stream \
--records file://records.json
```
Contents of `myfile.json`:
```
[
{"Data": "Rmlyc3QgdGhpbmc="},
{"Data": "U2Vjb25kIHRoaW5n"},
{"Data": "VGhpcmQgdGhpbmc="}
]
```
Output:
```
{
"FailedPutCount": 0,
"Encrypted": false,
"RequestResponses": [
{
"RecordId": "9D2OJ6t2EqCTZTXwGzeSv/EVHxRoRCw89xd+o3+sXg8DhYOaWKPSmZy/CGlRVEys1u1xbeKh6VofEYKkoeiDrcjrxhQp9iF7sUW7pujiMEQ5LzlrzCkGosxQn+3boDnURDEaD42V7GiixpOyLJkYZcae1i7HzlCEoy9LJhMr8EjDSi4Om/9Vc2uhwwuAtGE0XKpxJ2WD7ZRWtAnYlKAnvgSPRgg7zOWL"
},
{
"RecordId": "jFirejqxCLlK5xjH/UNmlMVcjktEN76I7916X9PaZ+PVaOSXDfU1WGOqEZhxq2js7xcZ552eoeDxsuTU1MSq9nZTbVfb6cQTIXnm/GsuF37Uhg67GKmR5z90l6XKJ+/+pDloFv7Hh9a3oUS6wYm3DcNRLTHHAimANp1PhkQvWpvLRfzbuCUkBphR2QVzhP9OiHLbzGwy8/DfH8sqWEUYASNJKS8GXP5s"
},
{
"RecordId": "oy0amQ40o5Y2YV4vxzufdcMOOw6n3EPr3tpPJGoYVNKH4APPVqNcbUgefo1stEFRg4hTLrf2k6eliHu/9+YJ5R3iiedHkdsfkIqX0XTySSutvgFYTjNY1TSrK0pM2sWxpjqqnk3+2UX1MV5z88xGro3cQm/DTBt3qBlmTj7Xq8SKVbO1S7YvMTpWkMKA86f8JfmT8BMKoMb4XZS/sOkQLe+qh0sYKXWl"
}
]
}
```
For more information, see [Sending Data to an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) in the *Amazon Kinesis Data Firehose Developer Guide*.
+ For API details, see [PutRecordBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record-batch.html) in *AWS CLI Command Reference*.
### `put-record`
The following code example shows how to use `put-record`.
**AWS CLI**
**To write a record to a stream**
The following `put-record` example writes data to a stream. The data is encoded in Base64 format.
```
aws firehose put-record \
--delivery-stream-name my-stream \
--record '{"Data":"SGVsbG8gd29ybGQ="}'
```
Output:
```
{
"RecordId": "RjB5K/nnoGFHqwTsZlNd/TTqvjE8V5dsyXZTQn2JXrdpMTOwssyEb6nfC8fwf1whhwnItt4mvrn+gsqeK5jB7QjuLg283+Ps4Sz/j1Xujv31iDhnPdaLw4BOyM9Amv7PcCuB2079RuM0NhoakbyUymlwY8yt20G8X2420wu1jlFafhci4erAt7QhDEvpwuK8N1uOQ1EuaKZWxQHDzcG6tk1E49IPeD9k",
"Encrypted": false
}
```
For more information, see [Sending Data to an Amazon Kinesis Data Firehose Delivery Stream](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) in the *Amazon Kinesis Data Firehose Developer Guide*.
+ For API details, see [PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record.html) in *AWS CLI Command Reference*.
# Amazon Data Lifecycle Manager examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Amazon Data Lifecycle Manager.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-default-role`
The following code example shows how to use `create-default-role`.
**AWS CLI**
**To create the required IAM role for Amazon DLM**
The following `dlm create-default-role` example creates the AWSDataLifecycleManagerDefaultRole default role for managing snapshots.
```
aws dlm create-default-role \
--resource-type snapshot
```
This command produces no output.
For more information, see [Default service roles for Amazon Data Lifecycle Manager](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/service-role.html#default-service-roles) in the *Amazon Elastic Compute Cloud User Guide*.
+ For API details, see [CreateDefaultRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-default-role.html) in *AWS CLI Command Reference*.
### `create-lifecycle-policy`
The following code example shows how to use `create-lifecycle-policy`.
**AWS CLI**
**To create a lifecycle policy**
The following `create-lifecycle-policy` example creates a lifecycle policy that creates a daily snapshot of volumes at the specified time. The specified tags are added to the snapshots, and tags are also copied from the volume and added to the snapshots. If creating a new snapshot exceeds the specified maximum count, the oldest snapshot is deleted.
```
aws dlm create-lifecycle-policy \
--description "My first policy" \
--state ENABLED \
--execution-role-arn arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRole \
--policy-details file://policyDetails.json
```
Contents of `policyDetails.json`:
```
{
"ResourceTypes": [
"VOLUME"
],
"TargetTags": [
{
"Key": "costCenter",
"Value": "115"
}
],
"Schedules":[
{
"Name": "DailySnapshots",
"CopyTags": true,
"TagsToAdd": [
{
"Key": "type",
"Value": "myDailySnapshot"
}
],
"CreateRule": {
"Interval": 24,
"IntervalUnit": "HOURS",
"Times": [
"03:00"
]
},
"RetainRule": {
"Count":5
}
}
]
}
```
Output:
```
{
"PolicyId": "policy-0123456789abcdef0"
}
```
+ For API details, see [CreateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-lifecycle-policy.html) in *AWS CLI Command Reference*.
### `delete-lifecycle-policy`
The following code example shows how to use `delete-lifecycle-policy`.
**AWS CLI**
**To delete a lifecycle policy**
The following example deletes the specified lifecycle policy.:
```
aws dlm delete-lifecycle-policy --policy-id policy-0123456789abcdef0
```
+ For API details, see [DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/delete-lifecycle-policy.html) in *AWS CLI Command Reference*.
### `get-lifecycle-policies`
The following code example shows how to use `get-lifecycle-policies`.
**AWS CLI**
**To get a summary of your lifecycle policies**
The following `get-lifecycle-policies` example lists all of your lifecycle policies.
```
aws dlm get-lifecycle-policies
```
Output:
```
{
"Policies": [
{
"PolicyId": "policy-0123456789abcdef0",
"Description": "My first policy",
"State": "ENABLED"
}
]
}
```
+ For API details, see [GetLifecyclePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policies.html) in *AWS CLI Command Reference*.
### `get-lifecycle-policy`
The following code example shows how to use `get-lifecycle-policy`.
**AWS CLI**
**To describe a lifecycle policy**
The following `get-lifecycle-policy` example displays details for the specified lifecycle policy.
```
aws dlm get-lifecycle-policy \
--policy-id policy-0123456789abcdef0
```
Output:
```
{
"Policy": {
"PolicyId": "policy-0123456789abcdef0",
"Description": "My policy",
"State": "ENABLED",
"ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole",
"DateCreated": "2019-08-08T17:45:42Z",
"DateModified": "2019-08-08T17:45:42Z",
"PolicyDetails": {
"PolicyType": "EBS_SNAPSHOT_MANAGEMENT",
"ResourceTypes": [
"VOLUME"
],
"TargetTags": [
{
"Key": "costCenter",
"Value": "115"
}
],
"Schedules": [
{
"Name": "DailySnapshots",
"CopyTags": true,
"TagsToAdd": [
{
"Key": "type",
"Value": "myDailySnapshot"
}
],
"CreateRule": {
"Interval": 24,
"IntervalUnit": "HOURS",
"Times": [
"03:00"
]
},
"RetainRule": {
"Count": 5
}
}
]
}
}
}
```
+ For API details, see [GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policy.html) in *AWS CLI Command Reference*.
### `update-lifecycle-policy`
The following code example shows how to use `update-lifecycle-policy`.
**AWS CLI**
**Example 1: To enable a lifecycle policy**
The following `update-lifecycle-policy` example enables the specified lifecycle policy.
```
aws dlm update-lifecycle-policy \
--policy-id policy-0123456789abcdef0 \
--state ENABLED
```
**Example 2: To disable a lifecycle policy**
The following `update-lifecycle-policy` example disables the specified lifecycle policy.
```
aws dlm update-lifecycle-policy \
--policy-id policy-0123456789abcdef0 \
--state DISABLED
```
**Example 3: To update the details for lifecycle policy**
The following `update-lifecycle-policy` example updates the target tags for the specified lifecycle policy.
```
aws dlm update-lifecycle-policy \
--policy-id policy-0123456789abcdef0
--policy-details file://policyDetails.json
```
Contents of `policyDetails.json`. Other details not referenced in this file are not changed by the command.
```
{
"TargetTags": [
{
"Key": "costCenter",
"Value": "120"
},
{
"Key": "project",
"Value": "lima"
}
]
}
```
+ For API details, see [UpdateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/update-lifecycle-policy.html) in *AWS CLI Command Reference*.
# AWS Data Pipeline examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS Data Pipeline.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `activate-pipeline`
The following code example shows how to use `activate-pipeline`.
**AWS CLI**
**To activate a pipeline**
This example activates the specified pipeline:
```
aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE
```
To activate the pipeline at a specific date and time, use the following command:
```
aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --start-timestamp 2015-04-07T00:00:00Z
```
+ For API details, see [ActivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/activate-pipeline.html) in *AWS CLI Command Reference*.
### `add-tags`
The following code example shows how to use `add-tags`.
**AWS CLI**
**To add a tag to a pipeline**
This example adds the specified tag to the specified pipeline:
```
aws datapipeline add-tags --pipeline-id df-00627471SOVYZEXAMPLE --tags key=environment,value=production key=owner,value=sales
```
To view the tags, use the describe-pipelines command. For example, the tags added in the example command appear as follows in the output for describe-pipelines:
```
{
...
"tags": [
{
"value": "production",
"key": "environment"
},
{
"value": "sales",
"key": "owner"
}
]
...
}
```
+ For API details, see [AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/add-tags.html) in *AWS CLI Command Reference*.
### `create-pipeline`
The following code example shows how to use `create-pipeline`.
**AWS CLI**
**To create a pipeline**
This example creates a pipeline:
```
aws datapipeline create-pipeline --name my-pipeline --unique-id my-pipeline-token
```
The following is example output:
```
{
"pipelineId": "df-00627471SOVYZEXAMPLE"
}
```
+ For API details, see [CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/create-pipeline.html) in *AWS CLI Command Reference*.
### `deactivate-pipeline`
The following code example shows how to use `deactivate-pipeline`.
**AWS CLI**
**To deactivate a pipeline**
This example deactivates the specified pipeline:
```
aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE
```
To deactivate the pipeline only after all running activities finish, use the following command:
```
aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --no-cancel-active
```
+ For API details, see [DeactivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/deactivate-pipeline.html) in *AWS CLI Command Reference*.
### `delete-pipeline`
The following code example shows how to use `delete-pipeline`.
**AWS CLI**
**To delete a pipeline**
This example deletes the specified pipeline:
```
aws datapipeline delete-pipeline --pipeline-id df-00627471SOVYZEXAMPLE
```
+ For API details, see [DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/delete-pipeline.html) in *AWS CLI Command Reference*.
### `describe-pipelines`
The following code example shows how to use `describe-pipelines`.
**AWS CLI**
**To describe your pipelines**
This example describes the specified pipeline:
```
aws datapipeline describe-pipelines --pipeline-ids df-00627471SOVYZEXAMPLE
```
The following is example output:
```
{
"pipelineDescriptionList": [
{
"fields": [
{
"stringValue": "PENDING",
"key": "@pipelineState"
},
{
"stringValue": "my-pipeline",
"key": "name"
},
{
"stringValue": "2015-04-07T16:05:58",
"key": "@creationTime"
},
{
"stringValue": "df-00627471SOVYZEXAMPLE",
"key": "@id"
},
{
"stringValue": "123456789012",
"key": "pipelineCreator"
},
{
"stringValue": "PIPELINE",
"key": "@sphere"
},
{
"stringValue": "123456789012",
"key": "@userId"
},
{
"stringValue": "123456789012",
"key": "@accountId"
},
{
"stringValue": "my-pipeline-token",
"key": "uniqueId"
}
],
"pipelineId": "df-00627471SOVYZEXAMPLE",
"name": "my-pipeline",
"tags": []
}
]
}
```
+ For API details, see [DescribePipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/describe-pipelines.html) in *AWS CLI Command Reference*.
### `get-pipeline-definition`
The following code example shows how to use `get-pipeline-definition`.
**AWS CLI**
**To get a pipeline definition**
This example gets the pipeline definition for the specified pipeline:
```
aws datapipeline get-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE
```
The following is example output:
```
{
"parameters": [
{
"type": "AWS::S3::ObjectKey",
"id": "myS3OutputLoc",
"description": "S3 output folder"
},
{
"default": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data",
"type": "AWS::S3::ObjectKey",
"id": "myS3InputLoc",
"description": "S3 input folder"
},
{
"default": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt",
"type": "String",
"id": "myShellCmd",
"description": "Shell command to run"
}
],
"objects": [
{
"type": "Ec2Resource",
"terminateAfter": "20 Minutes",
"instanceType": "t1.micro",
"id": "EC2ResourceObj",
"name": "EC2ResourceObj"
},
{
"name": "Default",
"failureAndRerunMode": "CASCADE",
"resourceRole": "DataPipelineDefaultResourceRole",
"schedule": {
"ref": "DefaultSchedule"
},
"role": "DataPipelineDefaultRole",
"scheduleType": "cron",
"id": "Default"
},
{
"directoryPath": "#{myS3OutputLoc}/#{format(@scheduledStartTime, 'YYYY-MM-dd-HH-mm-ss')}",
"type": "S3DataNode",
"id": "S3OutputLocation",
"name": "S3OutputLocation"
},
{
"directoryPath": "#{myS3InputLoc}",
"type": "S3DataNode",
"id": "S3InputLocation",
"name": "S3InputLocation"
},
{
"startAt": "FIRST_ACTIVATION_DATE_TIME",
"name": "Every 15 minutes",
"period": "15 minutes",
"occurrences": "4",
"type": "Schedule",
"id": "DefaultSchedule"
},
{
"name": "ShellCommandActivityObj",
"command": "#{myShellCmd}",
"output": {
"ref": "S3OutputLocation"
},
"input": {
"ref": "S3InputLocation"
},
"stage": "true",
"type": "ShellCommandActivity",
"id": "ShellCommandActivityObj",
"runsOn": {
"ref": "EC2ResourceObj"
}
}
],
"values": {
"myS3OutputLoc": "s3://amzn-s3-demo-bucket/",
"myS3InputLoc": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data",
"myShellCmd": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt"
}
}
```
+ For API details, see [GetPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/get-pipeline-definition.html) in *AWS CLI Command Reference*.
### `list-pipelines`
The following code example shows how to use `list-pipelines`.
**AWS CLI**
**To list your pipelines**
This example lists your pipelines:
```
aws datapipeline list-pipelines
```
The following is example output:
```
{
"pipelineIdList": [
{
"id": "df-00627471SOVYZEXAMPLE",
"name": "my-pipeline"
},
{
"id": "df-09028963KNVMREXAMPLE",
"name": "ImportDDB"
},
{
"id": "df-0870198233ZYVEXAMPLE",
"name": "CrossRegionDDB"
},
{
"id": "df-00189603TB4MZEXAMPLE",
"name": "CopyRedshift"
}
]
}
```
+ For API details, see [ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-pipelines.html) in *AWS CLI Command Reference*.
### `list-runs`
The following code example shows how to use `list-runs`.
**AWS CLI**
**Example 1: To list your pipeline runs**
The following `list-runs` example lists the runs for the specified pipeline.
```
aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE
```
Output:
```
Name Scheduled Start Status ID Started Ended
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10
2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09
3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09
4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09
```
**Example 2: To list the pipeline runs between the specified dates**
The following `list-runs` example uses the `--start-interval` to specify the dates to include in the output.
```
aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00
```
+ For API details, see [ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-runs.html) in *AWS CLI Command Reference*.
### `put-pipeline-definition`
The following code example shows how to use `put-pipeline-definition`.
**AWS CLI**
**To upload a pipeline definition**
This example uploads the specified pipeline definition to the specified pipeline:
```
aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json
```
The following is example output:
```
{
"validationErrors": [],
"errored": false,
"validationWarnings": []
}
```
+ For API details, see [PutPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/put-pipeline-definition.html) in *AWS CLI Command Reference*.
### `remove-tags`
The following code example shows how to use `remove-tags`.
**AWS CLI**
**To remove a tag from a pipeline**
This example removes the specified tag from the specified pipeline:
```
aws datapipeline remove-tags --pipeline-id df-00627471SOVYZEXAMPLE --tag-keys environment
```
+ For API details, see [RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/remove-tags.html) in *AWS CLI Command Reference*.
# DataSync examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with DataSync.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `update-location-azure-blob`
The following code example shows how to use `update-location-azure-blob`.
**AWS CLI**
**To update your transfer location with a new agent**
The following `update-location-object-storage` example updates your DataSync location for Microsoft Azure Blob Storage with a new agent.
```
aws datasync update-location-azure-blob \
--location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
--agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \
--sas-configuration '{ \
"Token": "sas-token-for-azure-blob-storage-access" \
}'
```
This command produces no output.
For more information, see [Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) in the *AWS DataSync User Guide*.
+ For API details, see [UpdateLocationAzureBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-azure-blob.html) in *AWS CLI Command Reference*.
### `update-location-hdfs`
The following code example shows how to use `update-location-hdfs`.
**AWS CLI**
**To update your transfer location with a new agent**
The following `update-location-hdfs` example updates your DataSync HDFS location with a new agent. You only need the `--kerberos-keytab` and `--kerberos-krb5-conf` options if your HDFS cluster uses Kerberos authentication.
```
aws datasync update-location-hdfs \
--location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
--agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \
--kerberos-keytab file://hdfs.keytab
--kerberos-krb5-conf file://krb5.conf
```
Contents of `hdfs.keytab`:
```
N/A. The content of this file is encrypted and not human readable.
```
Contents of `krb5.conf`:
```
[libdefaults]
default_realm = EXAMPLE.COM
dns_lookup_realm = false
dns_lookup_kdc = false
rdns = true
ticket_lifetime = 24h
forwardable = true
udp_preference_limit = 1000000
default_tkt_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1
default_tgs_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1
permitted_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1
[realms]
EXAMPLE.COM = {
kdc = kdc1.example.com
admin_server = krbadmin.example.com
default_domain = example.com
}
[domain_realm]
.example.com = EXAMPLE.COM
example.com = EXAMPLE.COM
[logging]
kdc = FILE:/var/log/krb5kdc.log
admin_server = FILE:/var/log/kerberos/kadmin.log
default = FILE:/var/log/krb5libs.log
```
This command produces no output.
For more information, see [Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) in the *AWS DataSync User Guide*.
+ For API details, see [UpdateLocationHdfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-hdfs.html) in *AWS CLI Command Reference*.
### `update-location-nfs`
The following code example shows how to use `update-location-nfs`.
**AWS CLI**
**To update your transfer location with a new agent**
The following `update-location-nfs` example updates your DataSync NFS location with a new agent.
```
aws datasync update-location-nfs \
--location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
--on-prem-config AgentArns=arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0
```
This command produces no output.
For more information, see [Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) in the *AWS DataSync User Guide*.
+ For API details, see [UpdateLocationNfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-nfs.html) in *AWS CLI Command Reference*.
### `update-location-object-storage`
The following code example shows how to use `update-location-object-storage`.
**AWS CLI**
**To update your transfer location with a new agent**
The following `update-location-object-storage` example updates your DataSync object storage location with a new agent.
```
aws datasync update-location-object-storage \
--location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
--agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \
--secret-key secret-key-for-object-storage
```
This command produces no output.
For more information, see [Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) in the *AWS DataSync User Guide*.
+ For API details, see [UpdateLocationObjectStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-object-storage.html) in *AWS CLI Command Reference*.
### `update-location-smb`
The following code example shows how to use `update-location-smb`.
**AWS CLI**
**To update your transfer location with a new agent**
The following `update-location-smb` example updates your DataSync SMB location with a new agent.
```
aws datasync update-location-smb \
--location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
--agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \
--password smb-file-server-password
```
This command produces no output.
For more information, see [Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html) in the *AWS DataSync User Guide*.
+ For API details, see [UpdateLocationSmb](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-smb.html) in *AWS CLI Command Reference*.
# DAX examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with DAX.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-cluster`
The following code example shows how to use `create-cluster`.
**AWS CLI**
**To create a DAX cluster**
The following `create-cluster` example creates a DAX cluster with the specified settings.
```
aws dax create-cluster \
--cluster-name daxcluster \
--node-type dax.r4.large \
--replication-factor 3 \
--iam-role-arn roleARN \
--sse-specification Enabled=true
```
Output:
```
{
"Cluster": {
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 3,
"ActiveNodes": 0,
"NodeType": "dax.r4.large",
"Status": "creating",
"ClusterDiscoveryEndpoint": {
"Port": 8111
},
"PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
}
```
For more information, see [Step 3: Create a DAX Cluster](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-cluster.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-cluster.html) in *AWS CLI Command Reference*.
### `create-parameter-group`
The following code example shows how to use `create-parameter-group`.
**AWS CLI**
**To create a parameter group**
The following `` create-parameter-group`` example creates a parameter group with the specified settings.
```
aws dax create-parameter-group \
--parameter-group-name daxparametergroup \
--description "A new parameter group"
```
Output:
```
{
"ParameterGroup": {
"ParameterGroupName": "daxparametergroup",
"Description": "A new parameter group"
}
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [CreateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-parameter-group.html) in *AWS CLI Command Reference*.
### `create-subnet-group`
The following code example shows how to use `create-subnet-group`.
**AWS CLI**
**To create a DAX subnet group**
The following `create-subnet-group` example creates a subnet group with the specified settings.
```
aws dax create-subnet-group \
--subnet-group-name daxSubnetGroup \
--subnet-ids subnet-11111111 subnet-22222222
```
Output:
```
{
"SubnetGroup": {
"SubnetGroupName": "daxSubnetGroup",
"VpcId": "vpc-05a1fa8e00c325226",
"Subnets": [
{
"SubnetIdentifier": "subnet-11111111",
"SubnetAvailabilityZone": "us-west-2b"
},
{
"SubnetIdentifier": "subnet-22222222",
"SubnetAvailabilityZone": "us-west-2c"
}
]
}
}
```
For more information, see [Step 2: Create a Subnet Group](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-subnet-group.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [CreateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-subnet-group.html) in *AWS CLI Command Reference*.
### `decrease-replication-factor`
The following code example shows how to use `decrease-replication-factor`.
**AWS CLI**
**To remove one or more nodes from the cluster**
The following `decrease-replication-factor` example decreases the number of nodes in the specified DAX cluster to one.
```
aws dax decrease-replication-factor \
--cluster-name daxcluster \
--new-replication-factor 1
```
Output:
```
{
"Cluster": {
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 3,
"ActiveNodes": 3,
"NodeType": "dax.r4.large",
"Status": "modifying",
"ClusterDiscoveryEndpoint": {
"Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"Nodes": [
{
"NodeId": "daxcluster-a",
"Endpoint": {
"Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"NodeCreateTime": 1576625059.509,
"AvailabilityZone": "us-west-2c",
"NodeStatus": "available",
"ParameterGroupStatus": "in-sync"
},
{
"NodeId": "daxcluster-b",
"Endpoint": {
"Address": "daxcluster-b.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"NodeCreateTime": 1576625059.509,
"AvailabilityZone": "us-west-2a",
"NodeStatus": "available",
"ParameterGroupStatus": "in-sync"
},
{
"NodeId": "daxcluster-c",
"Endpoint": {
"Address": "daxcluster-c.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"NodeCreateTime": 1576625059.509,
"AvailabilityZone": "us-west-2b",
"NodeStatus": "available",
"ParameterGroupStatus": "in-sync"
}
],
"PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DecreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/decrease-replication-factor.html) in *AWS CLI Command Reference*.
### `delete-cluster`
The following code example shows how to use `delete-cluster`.
**AWS CLI**
**To delete a DAX cluster**
The following `delete-cluster` example deletes the specified DAX cluster.
```
aws dax delete-cluster \
--cluster-name daxcluster
```
Output:
```
{
"Cluster": {
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 3,
"ActiveNodes": 0,
"NodeType": "dax.r4.large",
"Status": "deleting",
"ClusterDiscoveryEndpoint": {
"Address": "dd.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"PreferredMaintenanceWindow": "fri:06:00-fri:07:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.deleting) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-cluster.html) in *AWS CLI Command Reference*.
### `delete-parameter-group`
The following code example shows how to use `delete-parameter-group`.
**AWS CLI**
**To delete a parameter group**
The following `delete-parameter-group` example deletes the specified DAX parameter group.
```
aws dax delete-parameter-group \
--parameter-group-name daxparametergroup
```
Output:
```
{
"DeletionMessage": "Parameter group daxparametergroup has been deleted."
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DeleteParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-parameter-group.html) in *AWS CLI Command Reference*.
### `delete-subnet-group`
The following code example shows how to use `delete-subnet-group`.
**AWS CLI**
**To delete a subnet group**
The following `delete-subnet-group` example deletes the specified DAX subnet group.
```
aws dax delete-subnet-group \
--subnet-group-name daxSubnetGroup
```
Output:
```
{
"DeletionMessage": "Subnet group daxSubnetGroup has been deleted."
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DeleteSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-subnet-group.html) in *AWS CLI Command Reference*.
### `describe-clusters`
The following code example shows how to use `describe-clusters`.
**AWS CLI**
**To return information about all provisioned DAX clusters**
The following `describe-clusters` example displays details about all provisioned DAX clusters.
```
aws dax describe-clusters
```
Output:
```
{
"Clusters": [
{
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 1,
"ActiveNodes": 1,
"NodeType": "dax.r4.large",
"Status": "available",
"ClusterDiscoveryEndpoint": {
"Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"Nodes": [
{
"NodeId": "daxcluster-a",
"Endpoint": {
"Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"NodeCreateTime": 1576625059.509,
"AvailabilityZone": "us-west-2c",
"NodeStatus": "available",
"ParameterGroupStatus": "in-sync"
}
],
"PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-clusters.html) in *AWS CLI Command Reference*.
### `describe-default-parameters`
The following code example shows how to use `describe-default-parameters`.
**AWS CLI**
**To return the default system parameter information for DAX**
The following `describe-default-parameters` example displays the default system parameter information for DAX.
```
aws dax describe-default-parameters
```
Output:
```
{
"Parameters": [
{
"ParameterName": "query-ttl-millis",
"ParameterType": "DEFAULT",
"ParameterValue": "300000",
"NodeTypeSpecificValues": [],
"Description": "Duration in milliseconds for queries to remain cached",
"Source": "user",
"DataType": "integer",
"AllowedValues": "0-",
"IsModifiable": "TRUE",
"ChangeType": "IMMEDIATE"
},
{
"ParameterName": "record-ttl-millis",
"ParameterType": "DEFAULT",
"ParameterValue": "300000",
"NodeTypeSpecificValues": [],
"Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)",
"Source": "user",
"DataType": "integer",
"AllowedValues": "0-",
"IsModifiable": "TRUE",
"ChangeType": "IMMEDIATE"
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-default-parameters.html) in *AWS CLI Command Reference*.
### `describe-events`
The following code example shows how to use `describe-events`.
**AWS CLI**
**To return all events related to DAX clusters and parameter groups**
The following `describe-events` example displays details of events that are related to DAX clusters and parameter groups.
```
aws dax describe-events
```
Output:
```
{
"Events": [
{
"SourceName": "daxcluster",
"SourceType": "CLUSTER",
"Message": "Cluster deleted.",
"Date": 1576702736.706
},
{
"SourceName": "daxcluster",
"SourceType": "CLUSTER",
"Message": "Removed node daxcluster-b.",
"Date": 1576702691.738
},
{
"SourceName": "daxcluster",
"SourceType": "CLUSTER",
"Message": "Removed node daxcluster-a.",
"Date": 1576702633.498
},
{
"SourceName": "daxcluster",
"SourceType": "CLUSTER",
"Message": "Removed node daxcluster-c.",
"Date": 1576702631.329
},
{
"SourceName": "daxcluster",
"SourceType": "CLUSTER",
"Message": "Cluster created.",
"Date": 1576626560.057
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-events.html) in *AWS CLI Command Reference*.
### `describe-parameter-groups`
The following code example shows how to use `describe-parameter-groups`.
**AWS CLI**
**To describe the parameter groups defined in DAX**
The following `describe-parameter-groups` example retrieves details about the parameter groups that are defined in DAX.
```
aws dax describe-parameter-groups
```
Output:
```
{
"ParameterGroups": [
{
"ParameterGroupName": "default.dax1.0",
"Description": "Default parameter group for dax1.0"
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameter-groups.html) in *AWS CLI Command Reference*.
### `describe-parameters`
The following code example shows how to use `describe-parameters`.
**AWS CLI**
**To describe the parameters defined in a DAX parameter group**
The following `describe-parameters` example retrieves details about the parameters that are defined in the specified DAX parameter group.
```
aws dax describe-parameters \
--parameter-group-name default.dax1.0
```
Output:
```
{
"Parameters": [
{
"ParameterName": "query-ttl-millis",
"ParameterType": "DEFAULT",
"ParameterValue": "300000",
"NodeTypeSpecificValues": [],
"Description": "Duration in milliseconds for queries to remain cached",
"Source": "user",
"DataType": "integer",
"AllowedValues": "0-",
"IsModifiable": "TRUE",
"ChangeType": "IMMEDIATE"
},
{
"ParameterName": "record-ttl-millis",
"ParameterType": "DEFAULT",
"ParameterValue": "300000",
"NodeTypeSpecificValues": [],
"Description": "Duration in milliseconds for records to remain valid in cache (Default: 0 = infinite)",
"Source": "user",
"DataType": "integer",
"AllowedValues": "0-",
"IsModifiable": "TRUE",
"ChangeType": "IMMEDIATE"
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameters.html) in *AWS CLI Command Reference*.
### `describe-subnet-groups`
The following code example shows how to use `describe-subnet-groups`.
**AWS CLI**
**To describe subnet groups defined in DAX**
The following `describe-subnet-groups` example retrieves details for the subnet groups defined in DAX.
```
aws dax describe-subnet-groups
```
Output:
```
{
"SubnetGroups": [
{
"SubnetGroupName": "default",
"Description": "Default CacheSubnetGroup",
"VpcId": "vpc-ee70a196",
"Subnets": [
{
"SubnetIdentifier": "subnet-874953af",
"SubnetAvailabilityZone": "us-west-2d"
},
{
"SubnetIdentifier": "subnet-bd3d1fc4",
"SubnetAvailabilityZone": "us-west-2a"
},
{
"SubnetIdentifier": "subnet-72c2ff28",
"SubnetAvailabilityZone": "us-west-2c"
},
{
"SubnetIdentifier": "subnet-09e6aa42",
"SubnetAvailabilityZone": "us-west-2b"
}
]
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.cluster.security) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [DescribeSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-subnet-groups.html) in *AWS CLI Command Reference*.
### `increase-replication-factor`
The following code example shows how to use `increase-replication-factor`.
**AWS CLI**
**To increase the replication factor for a DAX cluster**
The following `increase-replication-factor` example increases the specified DAX cluster's replication factor to 3.
```
aws dax increase-replication-factor \
--cluster-name daxcluster \
--new-replication-factor 3
```
Output:
```
{
"Cluster": {
"ClusterName": "daxcluster",
"ClusterArn": "arn:aws:dax:us-west-2:123456789012:cache/daxcluster",
"TotalNodes": 3,
"ActiveNodes": 1,
"NodeType": "dax.r4.large",
"Status": "modifying",
"ClusterDiscoveryEndpoint": {
"Address": "daxcluster.ey3o9d.clustercfg.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"Nodes": [
{
"NodeId": "daxcluster-a",
"Endpoint": {
"Address": "daxcluster-a.ey3o9d.0001.dax.usw2.cache.amazonaws.com",
"Port": 8111
},
"NodeCreateTime": 1576625059.509,
"AvailabilityZone": "us-west-2c",
"NodeStatus": "available",
"ParameterGroupStatus": "in-sync"
},
{
"NodeId": "daxcluster-b",
"NodeStatus": "creating"
},
{
"NodeId": "daxcluster-c",
"NodeStatus": "creating"
}
],
"PreferredMaintenanceWindow": "thu:13:00-thu:14:00",
"SubnetGroup": "default",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "sg-1af6e36e",
"Status": "active"
}
],
"IamRoleArn": "arn:aws:iam::123456789012:role/DAXServiceRoleForDynamoDBAccess",
"ParameterGroup": {
"ParameterGroupName": "default.dax1.0",
"ParameterApplyStatus": "in-sync",
"NodeIdsToReboot": []
},
"SSEDescription": {
"Status": "ENABLED"
}
}
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [IncreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/increase-replication-factor.html) in *AWS CLI Command Reference*.
### `list-tags`
The following code example shows how to use `list-tags`.
**AWS CLI**
**To list tags on a DAX resource**
The following `list-tags` example lists the tag keys and values attached to the specified DAX cluster.
```
aws dax list-tags \
--resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster
```
Output:
```
{
"Tags": [
{
"Key": "ClusterUsage",
"Value": "prod"
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/list-tags.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To tag a DAX resource**
The following `tag-resource` example attaches the specified tag key name and associated value to the specified DAX cluster to describe the cluster usage.
```
aws dax tag-resource \
--resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \
--tags="Key=ClusterUsage,Value=prod"
```
Output:
```
{
"Tags": [
{
"Key": "ClusterUsage",
"Value": "prod"
}
]
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove tags from a DAX resource**
The following `untag-resource` example removes the tag with the specified key name from a DAX cluster.
```
aws dax untag-resource \
--resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \
--tag-keys="ClusterUsage"
```
Output:
```
{
"Tags": []
}
```
For more information, see [Managing DAX Clusters](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging) in the *Amazon DynamoDB Developer Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/untag-resource.html) in *AWS CLI Command Reference*.
# Detective examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Detective.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `accept-invitation`
The following code example shows how to use `accept-invitation`.
**AWS CLI**
**To accept an invitation to become a member account in a behavior graph**
The following `accept-invitation` example accepts an invitation to become a member account in behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234.
```
aws detective accept-invitation \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
This command produces no output.
For more information, see [Responding to a behavior graph invitation](https://docs.aws.amazon.com/detective/latest/adminguide/member-invitation-response.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [AcceptInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/accept-invitation.html) in *AWS CLI Command Reference*.
### `create-graph`
The following code example shows how to use `create-graph`.
**AWS CLI**
**To enable Amazon Detective and create a new behavior graph**
The following `create-graph` example enables Detective for the AWS account that runs the command in the Region where the command is run. A new behavior graph is created that has that account as its administrator account. The command also assigns the value Finance to the Department tag.
```
aws detective create-graph \
--tags '{"Department": "Finance"}'
```
Output:
```
{
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899"
}
```
For more information, see [Enabling Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-enabling.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [CreateGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-graph.html) in *AWS CLI Command Reference*.
### `create-members`
The following code example shows how to use `create-members`.
**AWS CLI**
**To invite member accounts to a behavior graph**
The following `create-members` example invites two AWS accounts to become member accounts in the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234. For each account, the request provides the AWS account ID and the account root user email address. The request includes a custom message to insert into the invitation email.
```
aws detective create-members \
--accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--message "This is Paul Santos. I need to add your account to the data we use for security investigation in Amazon Detective. If you have any questions, contact me at psantos@example.com."
```
Output:
```
{
"Members": [
{
"AccountId": "444455556666",
"AdministratorId": "111122223333",
"EmailAddress": "mmajor@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
},
{
"AccountId": "123456789012",
"AdministratorId": "111122223333",
"EmailAddress": "jstiles@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "VERIFICATION_IN_PROGRESS",
"UpdatedTime": 1579826107000
}
],
"UnprocessedAccounts": [ ]
}
```
For more information, see Inviting member accounts to a behavior graph in the *Amazon Detective Administration Guide*.
**To invite member accounts without sending invitation emails**
The following `create-members` example invites two AWS accounts to become member accounts in the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234. For each account, the request provides the AWS account ID and the account root user email address. The member accounts do not receive invitation emails.
```
aws detective create-members \
--accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--disable-email-notification
```
Output:
```
{
"Members": [
{
"AccountId": "444455556666",
"AdministratorId": "111122223333",
"EmailAddress": "mmajor@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
},
{
"AccountId": "123456789012",
"AdministratorId": "111122223333",
"EmailAddress": "jstiles@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "VERIFICATION_IN_PROGRESS",
"UpdatedTime": 1579826107000
}
],
"UnprocessedAccounts": [ ]
}
```
For more information, see Inviting member accounts to a behavior graph in the *Amazon Detective Administration Guide*.
+ For API details, see [CreateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-members.html) in *AWS CLI Command Reference*.
### `delete-graph`
The following code example shows how to use `delete-graph`.
**AWS CLI**
**To disable Detective and delete the behavior graph**
The following `delete-graph` example disables Detective and deletes the specified behavior graph.
```
aws detective delete-graph \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
This command produces no output.
For more information, see [Disabling Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-disabling.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [DeleteGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-graph.html) in *AWS CLI Command Reference*.
### `delete-members`
The following code example shows how to use `delete-members`.
**AWS CLI**
**To remove member accounts from a behavior graph**
The following `delete-members` example removes two member accounts from the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234. To identify the accounts, the request provides the AWS account IDs.
```
aws detective delete-members \
--account-ids 444455556666 123456789012 \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
Output:
```
{
"AccountIds": [ "444455556666", "123456789012" ],
"UnprocessedAccounts": [ ]
}
```
For more information, see Removing member accounts from a behavior graph in the *Amazon Detective Administration Guide*.
+ For API details, see [DeleteMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-members.html) in *AWS CLI Command Reference*.
### `disassociate-membership`
The following code example shows how to use `disassociate-membership`.
**AWS CLI**
**To resign membership from a behavior graph**
The following disassociate-membership example removes the AWS account that runs the command from the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234.
```
aws detective disassociate-membership \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
For more information, see Removing your account from a behavior graph in the *Amazon Detective Administration Guide*.
+ For API details, see [DisassociateMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/disassociate-membership.html) in *AWS CLI Command Reference*.
### `get-members`
The following code example shows how to use `get-members`.
**AWS CLI**
**To retrieve information about selected behavior graph member accounts**
The following `get-members` example retrieves information about two member accounts in the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234. For the two accounts, the request provides the AWS account IDs.
```
aws detective get-members \
--account-ids 444455556666 123456789012 \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
Output:
```
{
"MemberDetails": [
{
"AccountId": "444455556666",
"AdministratorId": "111122223333",
"EmailAddress": "mmajor@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
}
{
"AccountId": "123456789012",
"AdministratorId": "111122223333",
"EmailAddress": "jstiles@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
}
],
"UnprocessedAccounts": [ ]
}
```
For more information, see Viewing the list of accounts in a behavior graph in the *Amazon Detective Administration Guide*.
+ For API details, see [GetMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/get-members.html) in *AWS CLI Command Reference*.
### `list-graphs`
The following code example shows how to use `list-graphs`.
**AWS CLI**
**To view a list of behavior graphs that your account is the administrator for**
The following `list-graphs` example retrieves the behavior graphs that the calling account is the administrator for within the current Region.
```
aws detective list-graphs
```
Output:
```
{
"GraphList": [
{
"Arn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"CreatedTime": 1579736111000
}
]
}
```
+ For API details, see [ListGraphs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-graphs.html) in *AWS CLI Command Reference*.
### `list-invitations`
The following code example shows how to use `list-invitations`.
**AWS CLI**
**To view a list of behavior graphs that an account is a member of or is invited to**
The following `list-invitations` example retrieves the behavior graphs that the calling account has been invited to. The results include only open and accepted invitations. They do not include rejected invitations or removed memberships.
```
aws detective list-invitations
```
Output:
```
{
"Invitations": [
{
"AccountId": "444455556666",
"AdministratorId": "111122223333",
"EmailAddress": "mmajor@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
}
]
}
```
For more information, see Viewing your list of behavior graph invitations in the *Amazon Detective Administration Guide*.
+ For API details, see [ListInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-invitations.html) in *AWS CLI Command Reference*.
### `list-members`
The following code example shows how to use `list-members`.
**AWS CLI**
**To list the member accounts in a behavior graph**
The following `list-members` example retrieves the invited and enabled member accounts for the behavior graph `arn:aws:detective:us-east-1:111122223333:graph:123412341234`. The results do not include member accounts that were removed.
```
aws detective list-members \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
Output:
```
{
"MemberDetails": [
{
"AccountId": "444455556666",
"AdministratorId": "111122223333",
"EmailAddress": "mmajor@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"Status": "INVITED",
"UpdatedTime": 1579826107000
},
{
"AccountId": "123456789012",
"AdministratorId": "111122223333",
"EmailAddress": "jstiles@example.com",
"GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
"InvitedTime": 1579826107000,
"MasterId": "111122223333",
"PercentOfGraphUtilization": 2,
"PercentOfGraphUtilizationUpdatedTime": 1586287843,
"Status": "ENABLED",
"UpdatedTime": 1579973711000,
"VolumeUsageInBytes": 200,
"VolumeUsageUpdatedTime": 1586287843
}
]
}
```
For more information, see [Viewing the list of accounts in a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-view-accounts.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-members.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To retrieve the tags assigned to a behavior graph**
The following `list-tags-for-resource` example returns the tags assigned to the specified behavior graph.
```
aws detective list-tags-for-resource \
--resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
Output:
```
{
"Tags": {
"Department" : "Finance"
}
}
```
For more information, see [Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `reject-invitation`
The following code example shows how to use `reject-invitation`.
**AWS CLI**
**To reject an invitation to become a member account in a behavior graph**
The following `reject-invitation` example rejects an invitation to become a member account in the behavior graph arn:aws:detective:us-east-1:111122223333:graph:123412341234.
```
aws detective reject-invitation \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234
```
This command produces no output.
For more information, see Responding to a behavior graph invitation in the *Amazon Detective Administration Guide*.
+ For API details, see [RejectInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/reject-invitation.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To assign a tag to a resource**
The following `tag-resource` example assigns a value for the Department tag to the specified behavior graph.
```
aws detective tag-resource \
--resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--tags '{"Department":"Finance"}'
```
This command produces no output.
For more information, see [Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove a tag value from a resource**
The following `untag-resource` example removes the Department tag from the specified behavior graph.
```
aws detective untag-resource \
--resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--tag-keys "Department"
```
This command produces no output.
For more information, see [Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html) in the *Amazon Detective Administration Guide*.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/untag-resource.html) in *AWS CLI Command Reference*.
# Device Farm examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Device Farm.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-device-pool`
The following code example shows how to use `create-device-pool`.
**AWS CLI**
**To create a device pool**
The following command creates an Android device pool for a project:
```
aws devicefarm create-device-pool --name pool1 --rules file://device-pool-rules.json --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506"
```
You can get the project ARN from the output of `create-project` or `list-projects`. The file `device-pool-rules.json` is a JSON document in the current folder that specifies the device platform:
```
[
{
"attribute": "PLATFORM",
"operator": "EQUALS",
"value": "\"ANDROID\""
}
]
```
Output:
```
{
"devicePool": {
"rules": [
{
"operator": "EQUALS",
"attribute": "PLATFORM",
"value": "\"ANDROID\""
}
],
"type": "PRIVATE",
"name": "pool1",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:devicepool:070fc3ca-7ec1-4741-9c1f-d3e044efc506/2aa8d2a9-5e73-47ca-b929-659cb34b7dcd"
}
}
```
+ For API details, see [CreateDevicePool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-device-pool.html) in *AWS CLI Command Reference*.
### `create-project`
The following code example shows how to use `create-project`.
**AWS CLI**
**To create a project**
The following command creates a new project named `my-project`:
```
aws devicefarm create-project --name my-project
```
Output:
```
{
"project": {
"name": "myproject",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506",
"created": 1503612890.057
}
}
```
+ For API details, see [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-project.html) in *AWS CLI Command Reference*.
### `create-upload`
The following code example shows how to use `create-upload`.
**AWS CLI**
**To create an upload**
The following command creates an upload for an Android app:
```
aws devicefarm create-upload --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" --name app.apk --type ANDROID_APP
```
You can get the project ARN from the output of create-project or list-projects.
Output:
```
{
"upload": {
"status": "INITIALIZED",
"name": "app.apk",
"created": 1503614408.769,
"url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f",
"type": "ANDROID_APP",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514"
}
}
```
Use the signed URL in the output to upload a file to Device Farm:
```
curl -T app.apk "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f"
```
+ For API details, see [CreateUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-upload.html) in *AWS CLI Command Reference*.
### `get-upload`
The following code example shows how to use `get-upload`.
**AWS CLI**
**To view an upload**
The following command retrieves information about an upload:
```
aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514"
```
You can get the upload ARN from the output of `create-upload`.
Output:
```
{
"upload": {
"status": "SUCCEEDED",
"name": "app.apk",
"created": 1505262773.186,
"type": "ANDROID_APP",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514",
"metadata": "{\"device_admin\":false,\"activity_name\":\"ccom.example.client.LauncherActivity\",\"version_name\":\"1.0.2.94\",\"screens\":[\"small\",\"normal\",\"large\",\"xlarge\"],\"error_type\":null,\"sdk_version\":\"16\",\"package_name\":\"com.example.client\",\"version_code\":\"20994\",\"native_code\":[\"armeabi-v7a\"],\"target_sdk_version\":\"25\"}"
}
}
```
+ For API details, see [GetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/get-upload.html) in *AWS CLI Command Reference*.
### `list-projects`
The following code example shows how to use `list-projects`.
**AWS CLI**
**To list projects**
The following retrieves a list of projects:
```
aws devicefarm list-projects
```
Output:
```
{
"projects": [
{
"name": "myproject",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506",
"created": 1503612890.057
},
{
"name": "otherproject",
"arn": "arn:aws:devicefarm:us-west-2:123456789012:project:a5f5b752-8098-49d1-86bf-5f7682c1c77e",
"created": 1505257519.337
}
]
}
```
+ For API details, see [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/list-projects.html) in *AWS CLI Command Reference*.
# Direct Connect examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Direct Connect.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `accept-direct-connect-gateway-association-proposal`
The following code example shows how to use `accept-direct-connect-gateway-association-proposal`.
**AWS CLI**
**To accept a gateway association proposal**
The following `accept-direct-connect-gateway-association-proposal` accepts the specified proposal.
```
aws directconnect accept-direct-connect-gateway-association-proposal \
--direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \
--proposal-id cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE \
--associated-gateway-owner-account 111122223333
{
"directConnectGatewayAssociation": {
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"associationState": "associating",
"associatedGateway": {
"id": "tgw-02f776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"associationId": "6441f8bf-5917-4279-ade1-9708bEXAMPLE",
"allowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.1.0/30"
}
]
}
}
```
For more information, see [Accepting or Rejecting a Transit Gateway Association Proposal](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-accept-reject-proposal) in the *AWS Direct Connect User Guide*.
+ For API details, see [AcceptDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/accept-direct-connect-gateway-association-proposal.html) in *AWS CLI Command Reference*.
### `allocate-connection-on-interconnect`
The following code example shows how to use `allocate-connection-on-interconnect`.
**AWS CLI**
**To create a hosted connection on an interconnect**
The following `allocate-connection-on-interconnect` command creates a hosted connection on an interconnect:
```
aws directconnect allocate-connection-on-interconnect --bandwidth 500Mbps --connection-name mydcinterconnect --owner-account 123456789012 --interconnect-id dxcon-fgktov66 --vlan 101
```
Output:
```
{
"partnerName": "TIVIT",
"vlan": 101,
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffzc51m1",
"connectionState": "ordering",
"bandwidth": "500Mbps",
"location": "TIVIT",
"connectionName": "mydcinterconnect",
"region": "sa-east-1"
}
```
+ For API details, see [AllocateConnectionOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-connection-on-interconnect.html) in *AWS CLI Command Reference*.
### `allocate-hosted-connection`
The following code example shows how to use `allocate-hosted-connection`.
**AWS CLI**
**To create a hosted connection on an interconnect**
The following `allocate-hosted-connection` example creates a hosted connection on the specified interconnect.
```
aws directconnect allocate-hosted-connection \
--bandwidth 500Mbps \
--connection-name mydcinterconnect \
--owner-account 123456789012
-connection-id dxcon-fgktov66
-vlan 101
```
Output:
```
{
"partnerName": "TIVIT",
"vlan": 101,
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffzc51m1",
"connectionState": "ordering",
"bandwidth": "500Mbps",
"location": "TIVIT",
"connectionName": "mydcinterconnect",
"region": "sa-east-1"
}
```
+ For API details, see [AllocateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-hosted-connection.html) in *AWS CLI Command Reference*.
### `allocate-private-virtual-interface`
The following code example shows how to use `allocate-private-virtual-interface`.
**AWS CLI**
**To provision a private virtual interface**
The following `allocate-private-virtual-interface` command provisions a private virtual interface to be owned by a different customer:
```
aws directconnect allocate-private-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-private-virtual-interface-allocation virtualInterfaceName=PrivateVirtualInterface,vlan=1000,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30
```
Output:
```
{
"virtualInterfaceState": "confirming",
"asn": 65000,
"vlan": 1000,
"customerAddress": "192.168.1.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualInterfaceId": "dxvif-fgy8orxu",
"authKey": "asdf34example",
"routeFilterPrefixes": [],
"location": "TIVIT",
"customerRouterConfig": "\n \n 1000\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n",
"amazonAddress": "192.168.1.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "PrivateVirtualInterface"
}
```
+ For API details, see [AllocatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-private-virtual-interface.html) in *AWS CLI Command Reference*.
### `allocate-public-virtual-interface`
The following code example shows how to use `allocate-public-virtual-interface`.
**AWS CLI**
**To provision a public virtual interface**
The following `allocate-public-virtual-interface` command provisions a public virtual interface to be owned by a different customer:
```
aws directconnect allocate-public-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-public-virtual-interface-allocation virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}]
```
Output:
```
{
"virtualInterfaceState": "confirming",
"asn": 65000,
"vlan": 2000,
"customerAddress": "203.0.113.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualInterfaceId": "dxvif-fg9xo9vp",
"authKey": "asdf34example",
"routeFilterPrefixes": [
{
"cidr": "203.0.113.0/30"
},
{
"cidr": "203.0.113.4/30"
}
],
"location": "TIVIT",
"customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n",
"amazonAddress": "203.0.113.1/30",
"virtualInterfaceType": "public",
"virtualInterfaceName": "PublicVirtualInterface"
}
```
+ For API details, see [AllocatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-public-virtual-interface.html) in *AWS CLI Command Reference*.
### `allocate-transit-virtual-interface`
The following code example shows how to use `allocate-transit-virtual-interface`.
**AWS CLI**
**To provision a transit virtual interface to be owned by the specified AWS account**
The following `allocate-transit-virtual-interface` example provisions a transit virtual interface for the specified account.
```
aws directconnect allocate-transit-virtual-interface \
--connection-id dxlag-fEXAMPLE \
--owner-account 123456789012 \
--new-transit-virtual-interface-allocation "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,tags=[{key=Tag,value=Example}]"
```
Output:
```
{
"virtualInterface": {
"ownerAccount": "123456789012",
"virtualInterfaceId": "dxvif-fEXAMPLE",
"location": "loc1",
"connectionId": "dxlag-fEXAMPLE",
"virtualInterfaceType": "transit",
"virtualInterfaceName": "Example Transit Virtual Interface",
"vlan": 126,
"asn": 65110,
"amazonSideAsn": 7224,
"authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
"amazonAddress": "192.168.1.1/30",
"customerAddress": "192.168.1.2/30",
"addressFamily": "ipv4",
"virtualInterfaceState": "confirming",
"customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SEXAMPLE\n 7224\n transit\n\n",
"mtu": 1500,
"jumboFrameCapable": true,
"virtualGatewayId": "",
"directConnectGatewayId": "",
"routeFilterPrefixes": [],
"bgpPeers": [
{
"bgpPeerId": "dxpeer-fEXAMPLE",
"asn": 65110,
"authKey": "0xzxgA9YoW9h58u8EXAMPLE",
"addressFamily": "ipv4",
"amazonAddress": "192.168.1.1/30",
"customerAddress": "192.168.1.2/30",
"bgpPeerState": "pending",
"bgpStatus": "down",
"awsDeviceV2": "loc1-26wz6vEXAMPLE"
}
],
"region": "sa-east-1",
"awsDeviceV2": "loc1-26wz6vEXAMPLE",
"tags": [
{
"key": "Tag",
"value": "Example"
}
]
}
}
```
For more information, see [Creating a Hosted Transit Virtual Interface](https://docs.aws.amazon.com/directconnect/latest/UserGuide/createhostedvirtualinterface.html#create-hosted-transit-vif) in the *AWS Direct Connect User Guide*.
+ For API details, see [AllocateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-transit-virtual-interface.html) in *AWS CLI Command Reference*.
### `associate-connection-with-lag`
The following code example shows how to use `associate-connection-with-lag`.
**AWS CLI**
**To associate a connection with a LAG**
The following example associates the specified connection with the specified LAG.
Command:
```
aws directconnect associate-connection-with-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm
```
Output:
```
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg9607vm",
"lagId": "dxlag-fhccu14t",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "Con2ForLag",
"region": "us-east-1"
}
```
+ For API details, see [AssociateConnectionWithLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-connection-with-lag.html) in *AWS CLI Command Reference*.
### `associate-hosted-connection`
The following code example shows how to use `associate-hosted-connection`.
**AWS CLI**
**To associate a hosted connection with a LAG**
The following example associates the specified hosted connection with the specified LAG.
Command:
```
aws directconnect associate-hosted-connection --parent-connection-id dxlag-fhccu14t --connection-id dxcon-fg9607vm
```
Output:
```
{
"partnerName": "TIVIT",
"vlan": 101,
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg9607vm",
"lagId": "dxlag-fhccu14t",
"connectionState": "ordering",
"bandwidth": "500Mbps",
"location": "TIVIT",
"connectionName": "mydcinterconnect",
"region": "sa-east-1"
}
```
+ For API details, see [AssociateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-hosted-connection.html) in *AWS CLI Command Reference*.
### `associate-virtual-interface`
The following code example shows how to use `associate-virtual-interface`.
**AWS CLI**
**To associate a virtual interface with a connection**
The following example associates the specified virtual interface with the specified LAG. Alternatively, to associate the virtual interface with a connection, specify the ID of an AWS Direct Connect connection for `--connection-id`; for example, `dxcon-ffnikghc`.
Command:
```
aws directconnect associate-virtual-interface --connection-id dxlag-ffjhj9lx --virtual-interface-id dxvif-fgputw0j
```
Output:
```
{
"virtualInterfaceState": "pending",
"asn": 65000,
"vlan": 123,
"customerAddress": "169.254.255.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxlag-ffjhj9lx",
"addressFamily": "ipv4",
"virtualGatewayId": "vgw-38e90b51",
"virtualInterfaceId": "dxvif-fgputw0j",
"authKey": "0x123pK5_VBqv.UQ3kJ4123_",
"routeFilterPrefixes": [],
"location": "CSVA1",
"bgpPeers": [
{
"bgpStatus": "down",
"customerAddress": "169.254.255.2/30",
"addressFamily": "ipv4",
"authKey": "0x123pK5_VBqv.UQ3kJ4123_",
"bgpPeerState": "deleting",
"amazonAddress": "169.254.255.1/30",
"asn": 65000
},
{
"bgpStatus": "down",
"customerAddress": "169.254.255.2/30",
"addressFamily": "ipv4",
"authKey": "0x123pK5_VBqv.UQ3kJ4123_",
"bgpPeerState": "pending",
"amazonAddress": "169.254.255.1/30",
"asn": 65000
}
],
"customerRouterConfig": "\n\n 123\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0x123pK5_VBqv.UQ3kJ4123_\n 7224\n private\n\n",
"amazonAddress": "169.254.255.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "VIF1A"
}
```
+ For API details, see [AssociateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-virtual-interface.html) in *AWS CLI Command Reference*.
### `confirm-connection`
The following code example shows how to use `confirm-connection`.
**AWS CLI**
**To confirm the creation of a hosted connection on an interconnect**
The following `confirm-connection` command confirms the creation of a hosted connection on an interconnect:
```
aws directconnect confirm-connection --connection-id dxcon-fg2wi7hy
```
Output:
```
{
"connectionState": "pending"
}
```
+ For API details, see [ConfirmConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-connection.html) in *AWS CLI Command Reference*.
### `confirm-private-virtual-interface`
The following code example shows how to use `confirm-private-virtual-interface`.
**AWS CLI**
**To accept ownership of a private virtual interface**
The following `confirm-private-virtual-interface` command accepts ownership of a private virtual interface created by another customer:
```
aws directconnect confirm-private-virtual-interface --virtual-interface-id dxvif-fgy8orxu --virtual-gateway-id vgw-e4a47df9
```
Output:
```
{
"virtualInterfaceState": "pending"
}
```
+ For API details, see [ConfirmPrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-private-virtual-interface.html) in *AWS CLI Command Reference*.
### `confirm-public-virtual-interface`
The following code example shows how to use `confirm-public-virtual-interface`.
**AWS CLI**
**To accept ownership of a public virtual interface**
The following `confirm-public-virtual-interface` command accepts ownership of a public virtual interface created by another customer:
```
aws directconnect confirm-public-virtual-interface --virtual-interface-id dxvif-fg9xo9vp
```
Output:
```
{
"virtualInterfaceState": "verifying"
}
```
+ For API details, see [ConfirmPublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-public-virtual-interface.html) in *AWS CLI Command Reference*.
### `confirm-transit-virtual-interface`
The following code example shows how to use `confirm-transit-virtual-interface`.
**AWS CLI**
**To accept ownership of a transit virtual interface**
The following `confirm-transit-virtual-interface` accepts ownership of a transit virtual interface created by another customer.
```
aws directconnect confirm-transit-virtual-interface \
--virtual-interface-id dxvif-fEXAMPLE \
--direct-connect-gateway-id 4112ccf9-25e9-4111-8237-b6c5dEXAMPLE
```
Output:
```
{
"virtualInterfaceState": "pending"
}
```
For more information, see [Accepting a Hosted Virtual Interface](https://docs.aws.amazon.com/directconnect/latest/UserGuide/accepthostedvirtualinterface.html) in the *AWS Direct Connect User Guide*.
+ For API details, see [ConfirmTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-transit-virtual-interface.html) in *AWS CLI Command Reference*.
### `create-bgp-peer`
The following code example shows how to use `create-bgp-peer`.
**AWS CLI**
**To create an IPv6 BGP peering session**
The following example creates an IPv6 BGP peering session on private virtual interface `dxvif-fg1vuj3d`. The peer IPv6 addresses are automatically allocated by Amazon.
Command:
```
aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6
```
Output:
```
{
"virtualInterface": {
"virtualInterfaceState": "available",
"asn": 65000,
"vlan": 125,
"customerAddress": "169.254.255.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-fguhmqlc",
"addressFamily": "ipv4",
"virtualGatewayId": "vgw-f9eb0c90",
"virtualInterfaceId": "dxvif-fg1vuj3d",
"authKey": "0xC_ukbCerl6EYA0example",
"routeFilterPrefixes": [],
"location": "EqDC2",
"bgpPeers": [
{
"bgpStatus": "down",
"customerAddress": "169.254.255.2/30",
"addressFamily": "ipv4",
"authKey": "0xC_ukbCerl6EYA0uexample",
"bgpPeerState": "available",
"amazonAddress": "169.254.255.1/30",
"asn": 65000
},
{
"bgpStatus": "down",
"customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125",
"addressFamily": "ipv6",
"authKey": "0xS27kAIU_VHPjjAexample",
"bgpPeerState": "pending",
"amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125",
"asn": 64600
}
],
"customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0uexample\n 2001:db8:1100:2f0:0:1:9cb4:4216/125\n 2001:db8:1100:2f0:0:1:9cb4:4211/125\n 64600\n 0xS27kAIU_VHPjjAexample\n 7224\n private\n\n",
"amazonAddress": "169.254.255.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "Test"
}
}
```
+ For API details, see [CreateBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-bgp-peer.html) in *AWS CLI Command Reference*.
### `create-connection`
The following code example shows how to use `create-connection`.
**AWS CLI**
**To create a connection from your network to an AWS Direct Connect location**
The following `create-connection` command creates a connection from your network to an AWS Direct Connect location:
```
aws directconnect create-connection --location TIVIT --bandwidth 1Gbps --connection-name "Connection to AWS"
```
Output:
```
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg31dyv6",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "TIVIT",
"connectionName": "Connection to AWS",
"region": "sa-east-1"
}
```
+ For API details, see [CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-connection.html) in *AWS CLI Command Reference*.
### `create-direct-connect-gateway-association-proposal`
The following code example shows how to use `create-direct-connect-gateway-association-proposal`.
**AWS CLI**
**To create a proposal to associate the specified transit gateway with the specified Direct Connect gateway**
The following `create-direct-connect-gateway-association-proposal` example creates a proposal that associates the specified transit gateway with the specified Direct Connect gateway.
```
aws directconnect create-direct-connect-gateway-association-proposal \
--direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \
--direct-connect-gateway-owner-account 111122223333 \
--gateway-id tgw-02f776b1a7EXAMPLE \
--add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.1.0/30
```
Output:
```
{
"directConnectGatewayAssociationProposal": {
"proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE",
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"proposalState": "requested",
"associatedGateway": {
"id": "tgw-02f776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"requestedAllowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.1.0/30"
}
]
}
}
```
For more information, see [Creating a Transit Gateway Association Proposal](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-create-proposal) in the *AWS Direct Connect User Guide*.
+ For API details, see [CreateDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association-proposal.html) in *AWS CLI Command Reference*.
### `create-direct-connect-gateway-association`
The following code example shows how to use `create-direct-connect-gateway-association`.
**AWS CLI**
**To associate a virtual private gateway with a Direct Connect gateway**
The following example associates virtual private gateway `vgw-6efe725e` with Direct Connect gateway `5f294f92-bafb-4011-916d-9b0bexample`. You must run the command in the region in which the virtual private gateway is located.
Command:
```
aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e
```
Output:
```
{
"directConnectGatewayAssociation": {
"associationState": "associating",
"virtualGatewayOwnerAccount": "123456789012",
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
"virtualGatewayId": "vgw-6efe725e",
"virtualGatewayRegion": "us-east-2"
}
}
```
+ For API details, see [CreateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association.html) in *AWS CLI Command Reference*.
### `create-direct-connect-gateway`
The following code example shows how to use `create-direct-connect-gateway`.
**AWS CLI**
**To create a Direct Connect gateway**
The following example creates a Direct Connect gateway with the name `DxGateway1`.
Command:
```
aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1"
```
Output:
```
{
"directConnectGateway": {
"amazonSideAsn": 64512,
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample",
"ownerAccount": "123456789012",
"directConnectGatewayName": "DxGateway1",
"directConnectGatewayState": "available"
}
}
```
+ For API details, see [CreateDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway.html) in *AWS CLI Command Reference*.
### `create-interconnect`
The following code example shows how to use `create-interconnect`.
**AWS CLI**
**To create an interconnect between a partner's network and AWS**
The following `create-interconnect` command creates an interconnect between an AWS Direct Connect partner's network and a specific AWS Direct Connect location:
```
aws directconnect create-interconnect --interconnect-name "1G Interconnect to AWS" --bandwidth 1Gbps --location TIVIT
```
Output:
```
{
"region": "sa-east-1",
"bandwidth": "1Gbps",
"location": "TIVIT",
"interconnectName": "1G Interconnect to AWS",
"interconnectId": "dxcon-fgktov66",
"interconnectState": "requested"
}
```
+ For API details, see [CreateInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-interconnect.html) in *AWS CLI Command Reference*.
### `create-lag`
The following code example shows how to use `create-lag`.
**AWS CLI**
**To create a LAG with new connections**
The following example creates a LAG and requests two new AWS Direct Connect connections for the LAG with a bandwidth of 1 Gbps.
Command:
```
aws directconnect create-lag --location CSVA1 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 1GBLag
```
Output:
```
{
"awsDevice": "CSVA1-23u8tlpaz8iks",
"numberOfConnections": 2,
"lagState": "pending",
"ownerAccount": "123456789012",
"lagName": "1GBLag",
"connections": [
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffqr6x5q",
"lagId": "dxlag-ffjhj9lx",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "CSVA1",
"connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx",
"region": "us-east-1"
},
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fflqyj95",
"lagId": "dxlag-ffjhj9lx",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "CSVA1",
"connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx",
"region": "us-east-1"
}
],
"lagId": "dxlag-ffjhj9lx",
"minimumLinks": 0,
"connectionsBandwidth": "1Gbps",
"region": "us-east-1",
"location": "CSVA1"
}
```
**To create a LAG using an existing connection**
The following example creates a LAG from an existing connection in your account, and requests a second new connection for the LAG with the same bandwidth and location as the existing connection.
Command:
```
aws directconnect create-lag --location EqDC2 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 2ConnLAG --connection-id dxcon-fgk145dr
```
Output:
```
{
"awsDevice": "EqDC2-4h6ce2r1bes6",
"numberOfConnections": 2,
"lagState": "pending",
"ownerAccount": "123456789012",
"lagName": "2ConnLAG",
"connections": [
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fh6ljcvo",
"lagId": "dxlag-fhccu14t",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "Requested Connection 1 for Lag dxlag-fhccu14t",
"region": "us-east-1"
},
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fgk145dr",
"lagId": "dxlag-fhccu14t",
"connectionState": "down",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "VAConn1",
"region": "us-east-1"
}
],
"lagId": "dxlag-fhccu14t",
"minimumLinks": 0,
"connectionsBandwidth": "1Gbps",
"region": "us-east-1",
"location": "EqDC2"
}
```
+ For API details, see [CreateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-lag.html) in *AWS CLI Command Reference*.
### `create-private-virtual-interface`
The following code example shows how to use `create-private-virtual-interface`.
**AWS CLI**
**To create a private virtual interface**
The following `create-private-virtual-interface` command creates a private virtual interface:
```
aws directconnect create-private-virtual-interface --connection-id dxcon-ffjrkx17 --new-private-virtual-interface virtualInterfaceName=PrivateVirtualInterface,vlan=101,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,virtualGatewayId=vgw-aba37db6
```
Output:
```
{
"virtualInterfaceState": "pending",
"asn": 65000,
"vlan": 101,
"customerAddress": "192.168.1.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualGatewayId": "vgw-aba37db6",
"virtualInterfaceId": "dxvif-ffhhk74f",
"authKey": "asdf34example",
"routeFilterPrefixes": [],
"location": "TIVIT",
"customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n",
"amazonAddress": "192.168.1.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "PrivateVirtualInterface"
}
```
+ For API details, see [CreatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-private-virtual-interface.html) in *AWS CLI Command Reference*.
### `create-public-virtual-interface`
The following code example shows how to use `create-public-virtual-interface`.
**AWS CLI**
**To create a public virtual interface**
The following `create-public-virtual-interface` command creates a public virtual interface:
```
aws directconnect create-public-virtual-interface --connection-id dxcon-ffjrkx17 --new-public-virtual-interface virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}]
```
Output:
```
{
"virtualInterfaceState": "verifying",
"asn": 65000,
"vlan": 2000,
"customerAddress": "203.0.113.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualInterfaceId": "dxvif-fgh0hcrk",
"authKey": "asdf34example",
"routeFilterPrefixes": [
{
"cidr": "203.0.113.0/30"
},
{
"cidr": "203.0.113.4/30"
}
],
"location": "TIVIT",
"customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n",
"amazonAddress": "203.0.113.1/30",
"virtualInterfaceType": "public",
"virtualInterfaceName": "PublicVirtualInterface"
}
```
+ For API details, see [CreatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-public-virtual-interface.html) in *AWS CLI Command Reference*.
### `create-transit-virtual-interface`
The following code example shows how to use `create-transit-virtual-interface`.
**AWS CLI**
**To create a transit virtual interface**
The following `create-transit-virtual-interface` example creates a transit virtual interface for the specified connection.
```
aws directconnect create-transit-virtual-interface \
--connection-id dxlag-fEXAMPLE \
--new-transit-virtual-interface "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SvEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,directConnectGatewayId=8384da05-13ce-4a91-aada-5a1baEXAMPLE,tags=[{key=Tag,value=Example}]"
```
Output:
```
{
"virtualInterface": {
"ownerAccount": "1111222233333",
"virtualInterfaceId": "dxvif-fEXAMPLE",
"location": "loc1",
"connectionId": "dxlag-fEXAMPLE",
"virtualInterfaceType": "transit",
"virtualInterfaceName": "Example Transit Virtual Interface",
"vlan": 126,
"asn": 65110,
"amazonSideAsn": 4200000000,
"authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
"amazonAddress": "192.168.1.1/30",
"customerAddress": "192.168.1.2/30",
"addressFamily": "ipv4",
"virtualInterfaceState": "pending",
"customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SvOmXRTw\n 4200000000\n transit\n\n",
"mtu": 1500,
"jumboFrameCapable": true,
"virtualGatewayId": "",
"directConnectGatewayId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE",
"routeFilterPrefixes": [],
"bgpPeers": [
{
"bgpPeerId": "dxpeer-EXAMPLE",
"asn": 65110,
"authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
"addressFamily": "ipv4",
"amazonAddress": "192.168.1.1/30",
"customerAddress": "192.168.1.2/30",
"bgpPeerState": "pending",
"bgpStatus": "down",
"awsDeviceV2": "loc1-26wz6vEXAMPLE"
}
],
"region": "sa-east-1",
"awsDeviceV2": "loc1-26wz6vEXAMPLE",
"tags": [
{
"key": "Tag",
"value": "Example"
}
]
}
}
```
For more information, see [Creating a Transit Virtual Interface to the Direct Connect Gateway](https://docs.aws.amazon.com/directconnect/latest/UserGuide/create-vif.html#create-transit-vif) in the *AWS Direct Connect User Guide*.
+ For API details, see [CreateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-transit-virtual-interface.html) in *AWS CLI Command Reference*.
### `delete-bgp-peer`
The following code example shows how to use `delete-bgp-peer`.
**AWS CLI**
**To delete a BGP peer from a virtual interface**
The following example deletes the IPv6 BGP peer from virtual interface `dxvif-fg1vuj3d`.
Command:
```
aws directconnect delete-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --asn 64600 --customer-address 2001:db8:1100:2f0:0:1:9cb4:4216/125
```
Output:
```
{
"virtualInterface": {
"virtualInterfaceState": "available",
"asn": 65000,
"vlan": 125,
"customerAddress": "169.254.255.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-fguhmqlc",
"addressFamily": "ipv4",
"virtualGatewayId": "vgw-f9eb0c90",
"virtualInterfaceId": "dxvif-fg1vuj3d",
"authKey": "0xC_ukbCerl6EYA0example",
"routeFilterPrefixes": [],
"location": "EqDC2",
"bgpPeers": [
{
"bgpStatus": "down",
"customerAddress": "169.254.255.2/30",
"addressFamily": "ipv4",
"authKey": "0xC_ukbCerl6EYA0uexample",
"bgpPeerState": "available",
"amazonAddress": "169.254.255.1/30",
"asn": 65000
},
{
"bgpStatus": "down",
"customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125",
"addressFamily": "ipv6",
"authKey": "0xS27kAIU_VHPjjAexample",
"bgpPeerState": "deleting",
"amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125",
"asn": 64600
}
],
"customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0example\n 7224\n private\n\n",
"amazonAddress": "169.254.255.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "Test"
}
}
```
+ For API details, see [DeleteBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-bgp-peer.html) in *AWS CLI Command Reference*.
### `delete-connection`
The following code example shows how to use `delete-connection`.
**AWS CLI**
**To delete a connection**
The following `delete-connection` command deletes the specified connection:
```
aws directconnect delete-connection --connection-id dxcon-fg31dyv6
```
Output:
```
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg31dyv6",
"connectionState": "deleted",
"bandwidth": "1Gbps",
"location": "TIVIT",
"connectionName": "Connection to AWS",
"region": "sa-east-1"
}
```
+ For API details, see [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-connection.html) in *AWS CLI Command Reference*.
### `delete-direct-connect-gateway-association`
The following code example shows how to use `delete-direct-connect-gateway-association`.
**AWS CLI**
**To delete a Direct Connect gateway association**
The following `delete-direct-connect-gateway-association` example deletes the Direct Connect gateway association with a transit gateway that has the specified association ID.
```
aws directconnect delete-direct-connect-gateway-association --association-id be85116d-46eb-4b43-a27a-da0c2ad648de
```
Output:
```
{
"directConnectGatewayAssociation": {
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPlE",
"directConnectGatewayOwnerAccount": "123456789012",
"associationState": "disassociating",
"associatedGateway": {
"id": "tgw-095b3b0b54EXAMPLE",
"type": "transitGateway",
"ownerAccount": "123456789012",
"region": "us-east-1"
},
"associationId": " be85116d-46eb-4b43-a27a-da0c2ad648deEXAMPLE ",
"allowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.0.1.0/28"
}
]
}
}
```
For more information, see [Associating and Disassociating Transit Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway) in the *AWS Direct Connect User Guide*.
+ For API details, see [DeleteDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway-association.html) in *AWS CLI Command Reference*.
### `delete-direct-connect-gateway`
The following code example shows how to use `delete-direct-connect-gateway`.
**AWS CLI**
**To delete a Direct Connect gateway**
The following example deletes Direct Connect gateway `5f294f92-bafb-4011-916d-9b0bexample`.
Command:
```
aws directconnect delete-direct-connect-gateway --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample
```
Output:
```
{
"directConnectGateway": {
"amazonSideAsn": 64512,
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
"ownerAccount": "123456789012",
"directConnectGatewayName": "DxGateway1",
"directConnectGatewayState": "deleting"
}
}
```
+ For API details, see [DeleteDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway.html) in *AWS CLI Command Reference*.
### `delete-interconnect`
The following code example shows how to use `delete-interconnect`.
**AWS CLI**
**To delete an interconnect**
The following `delete-interconnect` command deletes the specified interconnect:
```
aws directconnect delete-interconnect --interconnect-id dxcon-fgktov66
```
Output:
```
{
"interconnectState": "deleted"
}
```
+ For API details, see [DeleteInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-interconnect.html) in *AWS CLI Command Reference*.
### `delete-lag`
The following code example shows how to use `delete-lag`.
**AWS CLI**
**To delete a LAG**
The following example deletes the specified LAG.
Command:
```
aws directconnect delete-lag --lag-id dxlag-ffrhowd9
```
Output:
```
{
"awsDevice": "EqDC2-4h6ce2r1bes6",
"numberOfConnections": 0,
"lagState": "deleted",
"ownerAccount": "123456789012",
"lagName": "TestLAG",
"connections": [],
"lagId": "dxlag-ffrhowd9",
"minimumLinks": 0,
"connectionsBandwidth": "1Gbps",
"region": "us-east-1",
"location": "EqDC2"
}
```
+ For API details, see [DeleteLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-lag.html) in *AWS CLI Command Reference*.
### `delete-virtual-interface`
The following code example shows how to use `delete-virtual-interface`.
**AWS CLI**
**To delete a virtual interface**
The following `delete-virtual-interface` command deletes the specified virtual interface:
```
aws directconnect delete-virtual-interface --virtual-interface-id dxvif-ffhhk74f
```
Output:
```
{
"virtualInterfaceState": "deleting"
}
```
+ For API details, see [DeleteVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-virtual-interface.html) in *AWS CLI Command Reference*.
### `describe-connection-loa`
The following code example shows how to use `describe-connection-loa`.
**AWS CLI**
**To describe your LOA-CFA for a connection using Linux or Mac OS X**
The following example describes your LOA-CFA for connection `dxcon-fh6ayh1d`. The contents of the LOA-CFA are base64-encoded. This command uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure. The final part of the command decodes the content using the `base64` utility, and sends the output to a PDF file.
```
aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf
```
**To describe your LOA-CFA for a connection using Windows**
The previous example requires the use of the `base64` utility to decode the output. On a Windows computer, you can use `certutil` instead. In the following example, the first command describes your LOA-CFA for connection `dxcon-fh6ayh1d` and uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure to a file called `myLoaCfa.base64`. The second command uses the `certutil` utility to decode the file and send the output to a PDF file.
```
aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64
```
```
certutil -decode myLoaCfa.base64 myLoaCfa.pdf
```
For more information about controlling AWS CLI output, see [Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [DescribeConnectionLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connection-loa.html) in *AWS CLI Command Reference*.
### `describe-connections-on-interconnect`
The following code example shows how to use `describe-connections-on-interconnect`.
**AWS CLI**
**To list connections on an interconnect**
The following `describe-connections-on-interconnect` command lists connections that have been provisioned on the given interconnect:
```
aws directconnect describe-connections-on-interconnect --interconnect-id dxcon-fgktov66
```
Output:
```
{
"connections": [
{
"partnerName": "TIVIT",
"vlan": 101,
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffzc51m1",
"connectionState": "ordering",
"bandwidth": "500Mbps",
"location": "TIVIT",
"connectionName": "mydcinterconnect",
"region": "sa-east-1"
}
]
}
```
+ For API details, see [DescribeConnectionsOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections-on-interconnect.html) in *AWS CLI Command Reference*.
### `describe-connections`
The following code example shows how to use `describe-connections`.
**AWS CLI**
**To list all connections in the current region**
The following `describe-connections` command lists all connections in the current region:
```
aws directconnect describe-connections
```
Output:
```
{
"connections": [
{
"awsDevice": "EqDC2-123h49s71dabc",
"ownerAccount": "123456789012",
"connectionId": "dxcon-fguhmqlc",
"lagId": "dxlag-ffrz71kw",
"connectionState": "down",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "My_Connection",
"loaIssueTime": 1491568964.0,
"region": "us-east-1"
}
]
}
```
+ For API details, see [DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections.html) in *AWS CLI Command Reference*.
### `describe-direct-connect-gateway-association-proposals`
The following code example shows how to use `describe-direct-connect-gateway-association-proposals`.
**AWS CLI**
**To describe your Direct Connect gateway association proposals**
The following `describe-direct-connect-gateway-association-proposals` example displays details about your Direct Connect gateway association proposals.
```
aws directconnect describe-direct-connect-gateway-association-proposals
```
Output:
```
{
"directConnectGatewayAssociationProposals": [
{
"proposalId": "c2ede9b4-bbc6-4d33-923c-bc4feEXAMPLE",
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"proposalState": "requested",
"associatedGateway": {
"id": "tgw-02f776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"existingAllowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.2.0/30"
},
{
"cidr": "192.168.1.0/30"
}
],
"requestedAllowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.1.0/30"
}
]
},
{
"proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE",
"directConnectGatewayId": "11560968-4ac1-4fd3-bcb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"proposalState": "accepted",
"associatedGateway": {
"id": "tgw-045776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"existingAllowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.4.0/30"
},
{
"cidr": "192.168.5.0/30"
}
],
"requestedAllowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.5.0/30"
}
]
}
]
}
```
For more information, see [Associating and Disassociating Transit Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway) in the *AWS Direct Connect User Guide*.
+ For API details, see [DescribeDirectConnectGatewayAssociationProposals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-association-proposals.html) in *AWS CLI Command Reference*.
### `describe-direct-connect-gateway-associations`
The following code example shows how to use `describe-direct-connect-gateway-associations`.
**AWS CLI**
**To describe Direct Connect gateway associations**
The following example describes all the associations with Direct Connect gateway `5f294f92-bafb-4011-916d-9b0bexample`.
Command:
```
aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample
```
Output:
```
{
"nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9",
"directConnectGatewayAssociations": [
{
"associationState": "associating",
"virtualGatewayOwnerAccount": "123456789012",
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
"virtualGatewayId": "vgw-6efe725e",
"virtualGatewayRegion": "us-east-2"
},
{
"associationState": "disassociating",
"virtualGatewayOwnerAccount": "123456789012",
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
"virtualGatewayId": "vgw-ebaa27db",
"virtualGatewayRegion": "us-east-2"
}
]
}
```
+ For API details, see [DescribeDirectConnectGatewayAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-associations.html) in *AWS CLI Command Reference*.
### `describe-direct-connect-gateway-attachments`
The following code example shows how to use `describe-direct-connect-gateway-attachments`.
**AWS CLI**
**To describe Direct Connect gateway attachments**
The following example describes the virtual interfaces that are attached to Direct Connect gateway `5f294f92-bafb-4011-916d-9b0bexample`.
Command:
```
aws directconnect describe-direct-connect-gateway-attachments --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample
```
Output:
```
{
"directConnectGatewayAttachments": [
{
"virtualInterfaceOwnerAccount": "123456789012",
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
"virtualInterfaceRegion": "us-east-2",
"attachmentState": "attaching",
"virtualInterfaceId": "dxvif-fg9zyabc"
}
],
"nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9"
}
```
+ For API details, see [DescribeDirectConnectGatewayAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-attachments.html) in *AWS CLI Command Reference*.
### `describe-direct-connect-gateways`
The following code example shows how to use `describe-direct-connect-gateways`.
**AWS CLI**
**To describe your Direct Connect gateways**
The following example describe all of your Direct Connect gateways.
Command:
```
aws directconnect describe-direct-connect-gateways
```
Output:
```
{
"directConnectGateways": [
{
"amazonSideAsn": 64512,
"directConnectGatewayId": "cf68415c-f4ae-48f2-87a7-3b52cexample",
"ownerAccount": "123456789012",
"directConnectGatewayName": "DxGateway2",
"directConnectGatewayState": "available"
},
{
"amazonSideAsn": 64512,
"directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample",
"ownerAccount": "123456789012",
"directConnectGatewayName": "DxGateway1",
"directConnectGatewayState": "available"
}
]
}
```
+ For API details, see [DescribeDirectConnectGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateways.html) in *AWS CLI Command Reference*.
### `describe-hosted-connections`
The following code example shows how to use `describe-hosted-connections`.
**AWS CLI**
**To list connections on an interconnect**
The following example lists connections that have been provisioned on the given interconnect.
Command:
```
aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66
```
Output:
```
{
"connections": [
{
"partnerName": "TIVIT",
"vlan": 101,
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffzc51m1",
"connectionState": "ordering",
"bandwidth": "500Mbps",
"location": "TIVIT",
"connectionName": "mydcinterconnect",
"region": "sa-east-1"
}
]
}
```
+ For API details, see [DescribeHostedConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-hosted-connections.html) in *AWS CLI Command Reference*.
### `describe-interconnect-loa`
The following code example shows how to use `describe-interconnect-loa`.
**AWS CLI**
**To describe your LOA-CFA for an interconnect using Linux or Mac OS X**
The following example describes your LOA-CFA for interconnect `dxcon-fh6ayh1d`. The contents of the LOA-CFA are base64-encoded. This command uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure. The final part of the command decodes the content using the `base64` utility, and sends the output to a PDF file.
```
aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf
```
**To describe your LOA-CFA for an interconnect using Windows**
The previous example requires the use of the `base64` utility to decode the output. On a Windows computer, you can use `certutil` instead. In the following example, the first command describes your LOA-CFA for interconnect `dxcon-fh6ayh1d` and uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure to a file called `myLoaCfa.base64`. The second command uses the `certutil` utility to decode the file and send the output to a PDF file.
```
aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64
```
```
certutil -decode myLoaCfa.base64 myLoaCfa.pdf
```
For more information about controlling AWS CLI output, see [Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [DescribeInterconnectLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnect-loa.html) in *AWS CLI Command Reference*.
### `describe-interconnects`
The following code example shows how to use `describe-interconnects`.
**AWS CLI**
**To list interconnects**
The following `describe-interconnects` command lists the interconnects owned by your AWS account:
```
aws directconnect describe-interconnects
```
Output:
```
{
"interconnects": [
{
"region": "sa-east-1",
"bandwidth": "1Gbps",
"location": "TIVIT",
"interconnectName": "1G Interconnect to AWS",
"interconnectId": "dxcon-fgktov66",
"interconnectState": "down"
}
]
}
```
+ For API details, see [DescribeInterconnects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnects.html) in *AWS CLI Command Reference*.
### `describe-lags`
The following code example shows how to use `describe-lags`.
**AWS CLI**
**To describe your LAGs**
The following command describes all of your LAGs for the current region.
Command:
```
aws directconnect describe-lags
```
Output:
```
{
"lags": [
{
"awsDevice": "EqDC2-19y7z3m17xpuz",
"numberOfConnections": 2,
"lagState": "down",
"ownerAccount": "123456789012",
"lagName": "DA-LAG",
"connections": [
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffnikghc",
"lagId": "dxlag-fgsu9erb",
"connectionState": "requested",
"bandwidth": "10Gbps",
"location": "EqDC2",
"connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb",
"region": "us-east-1"
},
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fglgbdea",
"lagId": "dxlag-fgsu9erb",
"connectionState": "requested",
"bandwidth": "10Gbps",
"location": "EqDC2",
"connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb",
"region": "us-east-1"
}
],
"lagId": "dxlag-fgsu9erb",
"minimumLinks": 0,
"connectionsBandwidth": "10Gbps",
"region": "us-east-1",
"location": "EqDC2"
}
]
}
```
+ For API details, see [DescribeLags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-lags.html) in *AWS CLI Command Reference*.
### `describe-loa`
The following code example shows how to use `describe-loa`.
**AWS CLI**
**To describe your LOA-CFA for a connection using Linux or Mac OS X**
The following example describes your LOA-CFA for connection `dxcon-fh6ayh1d`. The contents of the LOA-CFA are base64-encoded. This command uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure. The final part of the command decodes the content using the `base64` utility, and sends the output to a PDF file.
```
aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf
```
**To describe your LOA-CFA for a connection using Windows**
The previous example requires the use of the `base64` utility to decode the output. On a Windows computer, you can use `certutil` instead. In the following example, the first command describes your LOA-CFA for connection `dxcon-fh6ayh1d` and uses the `--output` and `--query` parameters to control the output and extract the contents of the `loaContent` structure to a file called `myLoaCfa.base64`. The second command uses the `certutil` utility to decode the file and send the output to a PDF file.
```
aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64
```
```
certutil -decode myLoaCfa.base64 myLoaCfa.pdf
```
For more information about controlling AWS CLI output, see [Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [DescribeLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-loa.html) in *AWS CLI Command Reference*.
### `describe-locations`
The following code example shows how to use `describe-locations`.
**AWS CLI**
**To list AWS Direct Connect partners and locations**
The following `describe-locations` command lists AWS Direct Connect partners and locations in the current region:
```
aws directconnect describe-locations
```
Output:
```
{
"locations": [
{
"locationName": "NAP do Brasil, Barueri, Sao Paulo",
"locationCode": "TNDB"
},
{
"locationName": "Tivit - Site Transamerica (Sao Paulo)",
"locationCode": "TIVIT"
}
]
}
```
+ For API details, see [DescribeLocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-locations.html) in *AWS CLI Command Reference*.
### `describe-tags`
The following code example shows how to use `describe-tags`.
**AWS CLI**
**To describe tags for your AWS Direct Connect resources**
The following command describes the tags for the connection `dxcon-abcabc12`.
Command:
```
aws directconnect describe-tags --resource-arns arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12
```
Output:
```
{
"resourceTags": [
{
"resourceArn": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12",
"tags": [
{
"value": "VAConnection",
"key": "Name"
}
]
}
]
}
```
+ For API details, see [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-tags.html) in *AWS CLI Command Reference*.
### `describe-virtual-gateways`
The following code example shows how to use `describe-virtual-gateways`.
**AWS CLI**
**To list virtual private gateways**
The following `describe-virtual-gateways` command lists virtual private gateways owned by your AWS account:
```
aws directconnect describe-virtual-gateways
```
Output:
```
{
"virtualGateways": [
{
"virtualGatewayId": "vgw-aba37db6",
"virtualGatewayState": "available"
}
]
}
```
+ For API details, see [DescribeVirtualGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-gateways.html) in *AWS CLI Command Reference*.
### `describe-virtual-interfaces`
The following code example shows how to use `describe-virtual-interfaces`.
**AWS CLI**
**To list all virtual interfaces**
The following `describe-virtual-interfaces` command lists the information about all virtual interfaces associated with your AWS account:
```
aws directconnect describe-virtual-interfaces --connection-id dxcon-ffjrkx17
```
Output:
```
{
"virtualInterfaces": [
{
"virtualInterfaceState": "down",
"asn": 65000,
"vlan": 101,
"customerAddress": "192.168.1.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualGatewayId": "vgw-aba37db6",
"virtualInterfaceId": "dxvif-ffhhk74f",
"authKey": "asdf34example",
"routeFilterPrefixes": [],
"location": "TIVIT",
"customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n",
"amazonAddress": "192.168.1.1/30",
"virtualInterfaceType": "private",
"virtualInterfaceName": "PrivateVirtualInterface"
},
{
"virtualInterfaceState": "verifying",
"asn": 65000,
"vlan": 2000,
"customerAddress": "203.0.113.2/30",
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffjrkx17",
"virtualGatewayId": "",
"virtualInterfaceId": "dxvif-fgh0hcrk",
"authKey": "asdf34example",
"routeFilterPrefixes": [
{
"cidr": "203.0.113.4/30"
},
{
"cidr": "203.0.113.0/30"
}
],
"location": "TIVIT",
"customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n",
"amazonAddress": "203.0.113.1/30",
"virtualInterfaceType": "public",
"virtualInterfaceName": "PublicVirtualInterface"
}
]
}
```
+ For API details, see [DescribeVirtualInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-interfaces.html) in *AWS CLI Command Reference*.
### `disassociate-connection-from-lag`
The following code example shows how to use `disassociate-connection-from-lag`.
**AWS CLI**
**To disassociate a connection from a LAG**
The following example disassociates the specified connection from the specified LAG.
Command:
```
aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm
```
Output:
```
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fg9607vm",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "EqDC2",
"connectionName": "Con2ForLag",
"region": "us-east-1"
}
```
+ For API details, see [DisassociateConnectionFromLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/disassociate-connection-from-lag.html) in *AWS CLI Command Reference*.
### `tag-resource`
The following code example shows how to use `tag-resource`.
**AWS CLI**
**To add a tag to an AWS Direct Connect resource**
The following command adds a tag with a key of `Name` and a value of `VAConnection` to the connection `dxcon-abcabc12`. If the command succeeds, no output is returned.
Command:
```
aws directconnect tag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tags "key=Name,value=VAConnection"
```
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/tag-resource.html) in *AWS CLI Command Reference*.
### `untag-resource`
The following code example shows how to use `untag-resource`.
**AWS CLI**
**To remove a tag from an AWS Direct Connect resource**
The following command removes the tag with the key `Name` from connection `dxcon-abcabc12`. If the command succeeds, no output is returned.
Command:
```
aws directconnect untag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tag-keys Name
```
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/untag-resource.html) in *AWS CLI Command Reference*.
### `update-direct-connect-gateway-association`
The following code example shows how to use `update-direct-connect-gateway-association`.
**AWS CLI**
**To update the specified attributes of the Direct Connect gateway association**
The following `update-direct-connect-gateway-association` example adds the specified CIDR block to a Direct Connect gateway association.
```
aws directconnect update-direct-connect-gateway-association \
--association-id 820a6e4f-5374-4004-8317-3f64bEXAMPLE \
--add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.2.0/30
```
Output:
```
{
"directConnectGatewayAssociation": {
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"associationState": "updating",
"associatedGateway": {
"id": "tgw-02f776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"associationId": "820a6e4f-5374-4004-8317-3f64bEXAMPLE",
"allowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.2.0/30"
},
{
"cidr": "192.168.1.0/30"
}
]
}
}
```
For more information, see [Working with Direct Connect Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-gateways.html) in the *AWS Direct Connect User Guide*.
+ For API details, see [UpdateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-direct-connect-gateway-association.html) in *AWS CLI Command Reference*.
### `update-lag`
The following code example shows how to use `update-lag`.
**AWS CLI**
**To update a LAG**
The following example changes the name of the specified LAG.
Command:
```
aws directconnect update-lag --lag-id dxlag-ffjhj9lx --lag-name 2ConnLag
```
Output:
```
{
"awsDevice": "CSVA1-23u8tlpaz8iks",
"numberOfConnections": 2,
"lagState": "down",
"ownerAccount": "123456789012",
"lagName": "2ConnLag",
"connections": [
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-fflqyj95",
"lagId": "dxlag-ffjhj9lx",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "CSVA1",
"connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx",
"region": "us-east-1"
},
{
"ownerAccount": "123456789012",
"connectionId": "dxcon-ffqr6x5q",
"lagId": "dxlag-ffjhj9lx",
"connectionState": "requested",
"bandwidth": "1Gbps",
"location": "CSVA1",
"connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx",
"region": "us-east-1"
}
],
"lagId": "dxlag-ffjhj9lx",
"minimumLinks": 0,
"connectionsBandwidth": "1Gbps",
"region": "us-east-1",
"location": "CSVA1"
}
```
+ For API details, see [UpdateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-lag.html) in *AWS CLI Command Reference*.
### `update-virtual-interface-attributes`
The following code example shows how to use `update-virtual-interface-attributes`.
**AWS CLI**
**To update the MTU of a virtual interface**
The following `update-virtual-interface-attributes` example updates the MTU of the specified virtual interface.
```
aws directconnect update-virtual-interface-attributes \
--virtual-interface-id dxvif-fEXAMPLE \
--mtu 1500
```
Output:
```
{
"ownerAccount": "1111222233333",
"virtualInterfaceId": "dxvif-fEXAMPLE",
"location": "loc1",
"connectionId": "dxlag-fEXAMPLE",
"virtualInterfaceType": "transit",
"virtualInterfaceName": "example transit virtual interface",
"vlan": 125,
"asn": 650001,
"amazonSideAsn": 64512,
"authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
"amazonAddress": "169.254.248.1/30",
"customerAddress": "169.254.248.2/30",
"addressFamily": "ipv4",
"virtualInterfaceState": "down",
"customerRouterConfig": "\n\n 125\n 169.254.248.2/30\n 169.254.248.1/30\n 650001\n 0xzxgA9YoW9h58u8SEXAMPLE\n 64512\n transit\n\n",
"mtu": 1500,
"jumboFrameCapable": true,
"virtualGatewayId": "",
"directConnectGatewayId": "879b76a1-403d-4700-8b53-4a56ed85436e",
"routeFilterPrefixes": [],
"bgpPeers": [
{
"bgpPeerId": "dxpeer-fEXAMPLE",
"asn": 650001,
"authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
"addressFamily": "ipv4",
"amazonAddress": "169.254.248.1/30",
"customerAddress": "169.254.248.2/30",
"bgpPeerState": "available",
"bgpStatus": "down",
"awsDeviceV2": "loc1-26wz6vEXAMPLE"
}
],
"region": "sa-east-1",
"awsDeviceV2": "loc1-26wz6vEXAMPLE",
"tags": []
}
```
For more information, see [Setting Network MTU for Private Virtual Interfaces or Transit Virtual Interfaces](https://docs.aws.amazon.com/directconnect/latest/UserGuide/set-jumbo-frames-vif.html) in the *AWS Direct Connect User Guide*.
+ For API details, see [UpdateVirtualInterfaceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-virtual-interface-attributes.html) in *AWS CLI Command Reference*.
# Directory Service examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Directory Service.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `describe-directories`
The following code example shows how to use `describe-directories`.
**AWS CLI**
**To get details about your directories**
The following `describe-directories` example displays details about the specified directory.
```
aws ds describe-directories \
--directory-id d-a1b2c3d4e5
```
Output:
```
{
"DirectoryDescriptions": [
{
"DirectoryId": "d-a1b2c3d4e5",
"Name": "mydirectory.example.com",
"ShortName": "mydirectory",
"Size": "Small",
"Edition": "Standard",
"Alias": "d-a1b2c3d4e5",
"AccessUrl": "d-a1b2c3d4e5.awsapps.com",
"Stage": "Active",
"ShareStatus": "Shared",
"ShareMethod": "HANDSHAKE",
"ShareNotes": "These are my share notes",
"LaunchTime": "2019-07-08T15:33:46.327000-07:00",
"StageLastUpdatedDateTime": "2019-07-08T15:59:12.307000-07:00",
"Type": "SharedMicrosoftAD",
"SsoEnabled": false,
"DesiredNumberOfDomainControllers": 0,
"OwnerDirectoryDescription": {
"DirectoryId": "d-b2c3d4e5f6",
"AccountId": "123456789111",
"DnsIpAddrs": [
"203.113.0.248",
"203.113.0.253"
],
"VpcSettings": {
"VpcId": "vpc-a1b2c3d4",
"SubnetIds": [
"subnet-a1b2c3d4",
"subnet-d4c3b2a1"
],
"AvailabilityZones": [
"us-west-2a",
"us-west-2c"
]
}
}
}
]
}
```
+ For API details, see [DescribeDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-directories.html) in *AWS CLI Command Reference*.
### `describe-trusts`
The following code example shows how to use `describe-trusts`.
**AWS CLI**
**To get details about your trust relationships**
The following `describe-trusts` example displays details about the trust relationships for the specified directory.
```
aws ds describe-trusts \
--directory-id d-a1b2c3d4e5
```
Output:
```
{
"Trusts": [
{
"DirectoryId": "d-a1b2c3d4e5",
"TrustId": "t-9a8b7c6d5e",
"RemoteDomainName": "other.example.com",
"TrustType": "Forest",
"TrustDirection": "Two-Way",
"TrustState": "Verified",
"CreatedDateTime": "2017-06-20T18:08:45.614000-07:00",
"LastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00",
"StateLastUpdatedDateTime": "2019-06-04T10:52:12.410000-07:00",
"SelectiveAuth": "Disabled"
}
]
}
```
+ For API details, see [DescribeTrusts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-trusts.html) in *AWS CLI Command Reference*.
# Directory Service Data examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with Directory Service Data.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `add-group-member`
The following code example shows how to use `add-group-member`.
**AWS CLI**
**To add a group member to a directory**
The following `add-group-member` example adds the specified user to the specified group in the specified directory.
```
aws ds-data add-group-member \
--directory-id d-1234567890 \
--group-name 'sales' \
--member-name 'john.doe'
```
This command produces no output.
For more information, see [Adding or removing AWS Managed Microsoft AD members to groups and groups to groups](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [AddGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/add-group-member.html) in *AWS CLI Command Reference*.
### `create-group`
The following code example shows how to use `create-group`.
**AWS CLI**
**To list the available widgets**
The following `create-group` example creates a group in a specified directory.
```
aws ds-data create-group \
--directory-id d-1234567890 \
--sam-account-name "sales"
```
Output:
```
{
"DirectoryId": "d-1234567890",
"SAMAccountName": "sales",
"SID": "S-1-2-34-5567891234-5678912345-67891234567-8912"
}
```
For more information, see [Creating an AWS Managed Microsoft AD group](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-group.html) in *AWS CLI Command Reference*.
### `create-user`
The following code example shows how to use `create-user`.
**AWS CLI**
**To create a user**
The following `create-user` example creates a user in the specified directory.
```
aws ds-data create-user \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'
```
Output:
```
{
"DirectoryId": "d-1234567890",
"SAMAccountName": "john.doe",
"SID": "S-1-2-34-5567891234-5678912345-67891234567-8912"
}
```
For more information, see [Creating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-user.html) in *AWS CLI Command Reference*.
### `delete-group`
The following code example shows how to use `delete-group`.
**AWS CLI**
**To delete a group**
The following `delete-group` example deletes the specified group from the specified directory.
```
aws ds-data delete-group \
--directory-id d-1234567890 \
--sam-account-name 'sales'
```
This command produces no output.
For more information, see [Deleting an AWS Managed Microsoft AD group](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-group.html) in *AWS CLI Command Reference*.
### `delete-user`
The following code example shows how to use `delete-user`.
**AWS CLI**
**To delete a user**
The following `delete-user` example deletes the specified user from the specified directory.
```
aws ds-data delete-user \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'
```
This command produces no output.
For more information, see [Deleting an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-user.html) in *AWS CLI Command Reference*.
### `describe-group`
The following code example shows how to use `describe-group`.
**AWS CLI**
**To list details of a group**
The following `describe-group` example gets information for the specified group in the specified directory.
```
aws ds-data describe-group \
--directory-id d-1234567890 \
--sam-account-name 'sales'
```
Output:
```
{
"DirectoryId": "d-1234567890",
"DistinguishedName": "CN=sales,OU=Users,OU=CORP,DC=corp,DC=example,DC=com",
"GroupScope": "Global",
"GroupType": "Security",
"Realm": "corp.example.com",
"SAMAccountName": "sales",
"SID": "S-1-2-34-5567891234-5678912345-67891234567-8912"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DescribeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-group.html) in *AWS CLI Command Reference*.
### `describe-user`
The following code example shows how to use `describe-user`.
**AWS CLI**
**To list information for a user**
The following `describe-user` example gets information for the specified user in the specified directory.
```
aws ds-data describe-user command-name \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'
```
Output:
```
{
"DirectoryId": "d-1234567890",
"DistinguishedName": "CN=john.doe,OU=Users,OU=CORP,DC=corp,DC=example,DC=com",
"Enabled": false,
"Realm": "corp.example.com",
"SAMAccountName": "john.doe",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567",
"UserPrincipalName": "john.doe@CORP.EXAMPLE.COM"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-user.html) in *AWS CLI Command Reference*.
### `disable-directory-data-access`
The following code example shows how to use `disable-directory-data-access`.
**AWS CLI**
**To disable Directory Service Data API for a directory**
The following `disable-directory-data-access` example disables the Directory Service Data API for the specified directory.
```
aws ds disable-directory-data-access \
--directory-id d-1234567890
```
This command produces no output.
For more information, see [Enabling or disabling user and group management or AWS Directory Service Data](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DisableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-directory-data-access.html) in *AWS CLI Command Reference*.
### `disable-user`
The following code example shows how to use `disable-user`.
**AWS CLI**
**To disable a user**
The following `disable-user` example disables the specified user in the specified directory.
```
aws ds-data disable-user \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'
```
This command produces no output.
For more information, see [Disabling an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_disable_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [DisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-user.html) in *AWS CLI Command Reference*.
### `enable-directory-data-access`
The following code example shows how to use `enable-directory-data-access`.
**AWS CLI**
**To enable Directory Service Data API for a directory**
The following `enable-directory-data-access` example enables the Directory Service Data API for the specified directory.
```
aws ds enable-directory-data-access \
--directory-id d-1234567890
```
This command produces no output.
For more information, see [Enabling or disabling user and group management or AWS Directory Service Data](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [EnableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/enable-directory-data-access.html) in *AWS CLI Command Reference*.
### `list-group-members`
The following code example shows how to use `list-group-members`.
**AWS CLI**
**To list a directory's group members**
The following `list-group-members` example lists the group members for the specified group in the specified directory.
```
aws ds-data list-group-members \
--directory-id d-1234567890 \
--sam-account-name 'sales'
```
Output:
```
{
"Members": [
{
"MemberType": "USER",
"SAMAccountName": "Jane Doe",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4568"
},
{
"MemberType": "USER",
"SAMAccountName": "John Doe",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4569"
}
],
"DirectoryId": "d-1234567890",
"MemberRealm": "corp.example.com",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [ListGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-group-members.html) in *AWS CLI Command Reference*.
### `list-groups-for-member`
The following code example shows how to use `list-groups-for-member`.
**AWS CLI**
**To list a directory's group membership**
The following `list-groups-for-member` example lists group membership for the specified user in the specified directory.
```
aws ds-data list-groups-for-member \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'
```
Output:
```
{
"Groups": [
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Users",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
}
],
"DirectoryId": "d-1234567890",
"MemberRealm": "corp.example.com",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [ListGroupsForMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups-for-member.html) in *AWS CLI Command Reference*.
### `list-groups`
The following code example shows how to use `list-groups`.
**AWS CLI**
**To list a directory's groups**
The following `list-groups` example lists groups in the specified directory.
```
aws ds-data list-groups \
--directory-id d-1234567890
```
Output:
```
{
"Groups": [
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Administrators",
"SID": "S-1-2-33-441"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Users",
"SID": "S-1-2-33-442"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Guests",
"SID": "S-1-2-33-443"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Print Operators",
"SID": "S-1-2-33-444"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Backup Operators",
"SID": "S-1-2-33-445"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Replicator",
"SID": "S-1-2-33-446"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Remote Desktop Users",
"SID": "S-1-2-33-447"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Network Configuration Operators",
"SID": "S-1-2-33-448"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Performance Monitor Users",
"SID": "S-1-2-33-449"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Performance Log Users",
"SID": "S-1-2-33-450"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Distributed COM Users",
"SID": "S-1-2-33-451"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "IIS_IUSRS",
"SID": "S-1-2-33-452"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Cryptographic Operators",
"SID": "S-1-2-33-453"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Event Log Readers",
"SID": "S-1-2-33-454"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Certificate Service DCOM Access",
"SID": "S-1-2-33-456"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "RDS Remote Access Servers",
"SID": "S-1-2-33-457"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "RDS Endpoint Servers",
"SID": "S-1-2-33-458"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "RDS Management Servers",
"SID": "S-1-2-33-459"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Hyper-V Administrators",
"SID": "S-1-2-33-460"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Access Control Assistance Operators",
"SID": "S-1-2-33-461"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Remote Management Users",
"SID": "S-1-2-33-462"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Storage Replica Administrators",
"SID": "S-1-2-33-463"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Computers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-789"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Controllers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-790"
},
{
"GroupScope": "Universal",
"GroupType": "Security",
"SAMAccountName": "Schema Admins",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-791"
},
{
"GroupScope": "Universal",
"GroupType": "Security",
"SAMAccountName": "Enterprise Admins",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-792"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "Cert Publishers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-793"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Admins",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-794"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Users",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-795"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Domain Guests",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-796"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Group Policy Creator Owners",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-797"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "RAS and IAS Servers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-798"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Server Operators",
"SID": "S-1-2-33-464"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Account Operators",
"SID": "S-1-2-33-465"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Pre-Windows 2000 Compatible Access",
"SID": "S-1-2-33-466"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Incoming Forest Trust Builders",
"SID": "S-1-2-33-467"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Windows Authorization Access Group",
"SID": "S-1-2-33-468"
},
{
"GroupScope": "BuiltinLocal",
"GroupType": "Security",
"SAMAccountName": "Terminal Server License Servers",
"SID": "S-1-2-33-469"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "Allowed RODC Password Replication Group",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-798"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "Denied RODC Password Replication Group",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-799"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Read-only Domain Controllers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-800"
},
{
"GroupScope": "Universal",
"GroupType": "Security",
"SAMAccountName": "Enterprise Read-only Domain Controllers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-801"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Cloneable Domain Controllers",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-802"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Protected Users",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-803"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Key Admins",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-804"
},
{
"GroupScope": "Universal",
"GroupType": "Security",
"SAMAccountName": "Enterprise Key Admins",
"SID": "S-1-2-34-56789123456-7891012345-6789123486-805"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "DnsAdmins",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "DnsUpdateProxy",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4568"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "Admins",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4569"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWSAdministrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4570"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Object Management Service Accounts",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4571"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Private CA Connector for AD Delegated Group",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4572"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Application and Service Delegated Group",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4573"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4574"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated FSx Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4575"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Account Operators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4576"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Active Directory Based Activation Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4577"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Allowed to Authenticate Objects",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4578"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Allowed to Authenticate to Domain Controllers",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4579"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Deleted Object Lifetime Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4580"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Distributed File System Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4581"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Dynamic Host Configuration Protocol Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4582"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Enterprise Certificate Authority Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4583"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Fine Grained Password Policy Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4584"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Group Policy Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4585"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Managed Service Account Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4586"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Read Foreign Security Principals",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4587"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Remote Access Service Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4588"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Replicate Directory Changes Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4588"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Sites and Services Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4589"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated System Management Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4590"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Terminal Server Licensing Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4591"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated User Principal Name Suffix Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4592"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Add Workstations To Domain Users",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4593"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Domain Name System Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4594"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Kerberos Delegation Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4595"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated Server Administrators",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4596"
},
{
"GroupScope": "DomainLocal",
"GroupType": "Security",
"SAMAccountName": "AWS Delegated MS-NPRC Non-Compliant Devices",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4597"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Remote Access",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4598"
},
{
"GroupScope": "Global",
"GroupType": "Security",
"SAMAccountName": "Accounting",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4599"
},
{
"GroupScope": "Global",
"GroupType": "Distribution",
"SAMAccountName": "sales",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
}
],
"DirectoryId": "d-1234567890",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups.html) in *AWS CLI Command Reference*.
### `list-users`
The following code example shows how to use `list-users`.
**AWS CLI**
**To list a directory's users**
The following `list-users` example lists users in the specified directory.
```
aws ds-data list-users \
--directory-id d-1234567890
```
Output:
```
{
"Users": [
{
"Enabled": true,
"SAMAccountName": "Administrator",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-345"
},
{
"Enabled": false,
"SAMAccountName": "Guest",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-345"
},
{
"Enabled": false,
"SAMAccountName": "krbtgt",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-346"
},
{
"Enabled": true,
"SAMAccountName": "Admin",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-347"
},
{
"Enabled": true,
"SAMAccountName": "Richard Roe",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-348"
},
{
"Enabled": true,
"SAMAccountName": "Jane Doe",
"SID": "S-1-2-34-5678910123-4567895012-3456789012-349"
},
{
"Enabled": true,
"SAMAccountName": "AWS_WGnzYlN6YyY",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
},
{
"Enabled": true,
"SAMAccountName": "john.doe",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4568"
}
],
"DirectoryId": "d-1234567890",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-users.html) in *AWS CLI Command Reference*.
### `remove-group-member`
The following code example shows how to use `remove-group-member`.
**AWS CLI**
**To remove a group member from a directory**
The following `remove-group-member` example removes the specified group member from the specified group in the specified directory.
```
aws ds-data remove-group-member \
--directory-id d-1234567890 \
--group-name 'sales' \
--member-name 'john.doe'
```
This command produces no output.
For more information, see [Adding and removing AWS Managed Microsoft AD members to groups and groups to groups](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [RemoveGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/remove-group-member.html) in *AWS CLI Command Reference*.
### `reset-user-password`
The following code example shows how to use `reset-user-password`.
**AWS CLI**
**To reset a user password in a directory**
The following `reset-user-password` example resets and enables the specified user in the specified directory.
```
aws ds reset-user-password \
--directory-id d-1234567890 \
--user-name 'john.doe' \
--new-password 'password'
```
This command produces no output.
For more information, see [Resetting and enabling an AWS Managed Microsoft AD user's password](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_reset_user_pswd.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [ResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/reset-user-password.html) in *AWS CLI Command Reference*.
### `search-groups`
The following code example shows how to use `search-groups`.
**AWS CLI**
**To search for a group in a directory**
The following `search-groups` example searches for the specified group in the specified directory.
```
aws ds-data search-groups \
--directory-id d-1234567890 \
--search-attributes 'SamAccountName' \
--search-string 'sales'
```
Output:
```
{
"Groups": [
{
"GroupScope": "Global",
"GroupType": "Distribution",
"SAMAccountName": "sales",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
}
],
"DirectoryId": "d-1234567890",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [SearchGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-groups.html) in *AWS CLI Command Reference*.
### `search-users`
The following code example shows how to use `search-users`.
**AWS CLI**
**To search for a user in a directory**
The following `search-users` example searches for the specified user in the specified directory.
```
aws ds-data search-users \
--directory-id d-1234567890 \
--search-attributes 'SamAccountName' \
--Search-string 'john.doe'
```
Output:
```
{
"Users": [
{
"Enabled": true,
"SAMAccountName": "john.doe",
"SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
}
],
"DirectoryId": "d-1234567890",
"Realm": "corp.example.com"
}
```
For more information, see [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [SearchUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-users.html) in *AWS CLI Command Reference*.
### `update-group`
The following code example shows how to use `update-group`.
**AWS CLI**
**To update a group's attribute in a directory**
The following `update-group` example updates the specified attribute for the specified group in the specified directory.
```
aws ds-data update-group \
--directory-id d-1234567890 \
--sam-account-name 'sales' \
--update-type 'REPLACE' \
--group-type 'Distribution'
```
This command produces no output.
For more information, see [Viewing and updating an AWS Managed Microsoft AD group's details](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-group.html) in *AWS CLI Command Reference*.
### `update-user`
The following code example shows how to use `update-user`.
**AWS CLI**
**To update a user's attribute in a directory**
The following `update-user` example updates the specified attribute for the specified user in the specified directory.
```
aws ds-data update-user \
--directory-id d-1234567890 \
--sam-account-name 'john.doe' \
--update-type 'ADD' \
--email-address 'example.corp.com'
```
This command produces no output.
For more information, see [Viewing and updating an AWS Managed Microsoft AD user](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html) in the *AWS Directory Service Administration Guide*.
+ For API details, see [UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-user.html) in *AWS CLI Command Reference*.
# AWS DMS examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS DMS.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `add-tags-to-resource`
The following code example shows how to use `add-tags-to-resource`.
**AWS CLI**
**To add tags to a resource**
The following `add-tags-to-resource` example adds tags to a replication instance.
```
aws dms add-tags-to-resource \
--resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \
--tags Key=Environment,Value=PROD Key=Project,Value=dbMigration
```
This command produces no output.
For more information, see [Tagging Resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/add-tags-to-resource.html) in *AWS CLI Command Reference*.
### `create-endpoint`
The following code example shows how to use `create-endpoint`.
**AWS CLI**
**To create an endpoint**
The following `create-endpoint` example creates an endpoint for an Amazon S3 source.
```
aws dms create-endpoint \
--endpoint-type source \
--engine-name s3 \
--endpoint-identifier src-endpoint \
--s3-settings file://s3-settings.json
```
Contents of `s3-settings.json`:
```
{
"BucketName":"my-corp-data",
"BucketFolder":"sourcedata",
"ServiceAccessRoleArn":"arn:aws:iam::123456789012:role/my-s3-access-role"
}
```
Output:
```
{
"Endpoint": {
"EndpointIdentifier": "src-endpoint",
"EndpointType": "SOURCE",
"EngineName": "s3",
"EngineDisplayName": "Amazon S3",
"ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;",
"Status": "active",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U",
"SslMode": "none",
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"S3Settings": {
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"CsvRowDelimiter": "\\n",
"CsvDelimiter": ",",
"BucketFolder": "sourcedata",
"BucketName": "my-corp-data",
"CompressionType": "NONE",
"EnableStatistics": true
}
}
}
```
For more information, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-endpoint.html) in *AWS CLI Command Reference*.
### `create-event-subscription`
The following code example shows how to use `create-event-subscription`.
**AWS CLI**
**To list event subscriptions**
The following `create-event-subscription` example creates an event subscription to an Amazon SNS topic (my-sns-topic).
```
aws dms create-event-subscription \
--subscription-name my-dms-events \
--sns-topic-arn arn:aws:sns:us-east-1:123456789012:my-sns-topic
```
Output:
```
{
"EventSubscription": {
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "my-dms-events",
"SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
"Status": "creating",
"SubscriptionCreationTime": "2020-05-21 21:58:38.598",
"Enabled": true
}
}
```
For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-event-subscription.html) in *AWS CLI Command Reference*.
### `create-replication-instance`
The following code example shows how to use `create-replication-instance`.
**AWS CLI**
**To create a replication instance**
The following `create-replication-instance` example creates a replication instance.
```
aws dms create-replication-instance \
--replication-instance-identifier my-repl-instance \
--replication-instance-class dms.t2.micro \
--allocated-storage 5
```
Output:
```
{
"ReplicationInstance": {
"ReplicationInstanceIdentifier": "my-repl-instance",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceStatus": "creating",
"AllocatedStorage": 5,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-f839b688",
"Status": "active"
}
],
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "default",
"ReplicationSubnetGroupDescription": "default",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-42599426",
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-6746046b",
"SubnetAvailabilityZone": {
"Name": "us-east-1f"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-cbfff283",
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetStatus": "Active"
}
]
},
"PreferredMaintenanceWindow": "sat:12:35-sat:13:05",
"PendingModifiedValues": {},
"MultiAZ": false,
"EngineVersion": "3.3.2",
"AutoMinorVersionUpgrade": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:ZK2VQBUWFDBAWHIXHAYG5G2PKY",
"PubliclyAccessible": true
}
}
```
For more information, see [Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [CreateReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-instance.html) in *AWS CLI Command Reference*.
### `create-replication-subnet-group`
The following code example shows how to use `create-replication-subnet-group`.
**AWS CLI**
**To create a subnet group**
The following `create-replication-subnet-group` example creates a group consisting of 3 subnets.
```
aws dms create-replication-subnet-group \
--replication-subnet-group-identifier my-subnet-group \
--replication-subnet-group-description "my subnet group" \
--subnet-ids subnet-da327bf6 subnet-bac383e0 subnet-d7c825e8
```
Output:
```
{
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "my-subnet-group",
"ReplicationSubnetGroupDescription": "my subnet group",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
}
]
}
}
```
For more information, see [Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [CreateReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-subnet-group.html) in *AWS CLI Command Reference*.
### `create-replication-task`
The following code example shows how to use `create-replication-task`.
**AWS CLI**
**To create a replication task**
The following `create-replication-task` example creates a replication task.
```
aws dms create-replication-task \
--replication-task-identifier movedata \
--source-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \
--target-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U \
--replication-instance-arn $RI_ARN \
--migration-type full-load \
--table-mappings file://table-mappings.json
```
Contents of `table-mappings.json`:
```
{
"rules": [
{
"rule-type": "selection",
"rule-id": "1",
"rule-name": "1",
"object-locator": {
"schema-name": "prodrep",
"table-name": "%"
},
"rule-action": "include",
"filters": []
}
]
}
```
Output:
```
{
"ReplicationTask": {
"ReplicationTaskIdentifier": "moveit2",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"MigrationType": "full-load",
"TableMappings": ...output omitted... ,
"ReplicationTaskSettings": ...output omitted... ,
"Status": "creating",
"ReplicationTaskCreationDate": 1590524772.505,
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
}
}
```
For more information, see [Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [CreateReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-task.html) in *AWS CLI Command Reference*.
### `delete-connection`
The following code example shows how to use `delete-connection`.
**AWS CLI**
**To delete a connection**
The following `delete-connection` example disassociates an endpoint from a replication instance.
```
aws dms delete-connection \
--endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA \
--replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE
```
Output:
```
{
"Connection": {
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"Status": "deleting",
"EndpointIdentifier": "src-database-1",
"ReplicationInstanceIdentifier": "my-repl-instance"
}
}
```
For more information, see [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Endpoints.Creating.html](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-connection.html) in *AWS CLI Command Reference*.
### `delete-endpoint`
The following code example shows how to use `delete-endpoint`.
**AWS CLI**
**To delete an endpoint**
The following `delete-endpoint` example deletes an endpoint.
```
aws dms delete-endpoint \
--endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y
```
Output:
```
{
"Endpoint": {
"EndpointIdentifier": "src-endpoint",
"EndpointType": "SOURCE",
"EngineName": "s3",
"EngineDisplayName": "Amazon S3",
"ExtraConnectionAttributes": "bucketFolder=sourcedata;bucketName=my-corp-data;compressionType=NONE;csvDelimiter=,;csvRowDelimiter=\\n;",
"Status": "deleting",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y",
"SslMode": "none",
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"S3Settings": {
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"CsvRowDelimiter": "\\n",
"CsvDelimiter": ",",
"BucketFolder": "sourcedata",
"BucketName": "my-corp-data",
"CompressionType": "NONE",
"EnableStatistics": true
}
}
}
```
For more information, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-endpoint.html) in *AWS CLI Command Reference*.
### `delete-event-subscription`
The following code example shows how to use `delete-event-subscription`.
**AWS CLI**
**To delete an event subscription**
The following `delete-event-subscription` example deletes a subscription to an Amazon SNS topic.
```
aws dms delete-event-subscription \
--subscription-name "my-dms-events"
```
Output:
```
{
"EventSubscription": {
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "my-dms-events",
"SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
"Status": "deleting",
"SubscriptionCreationTime": "2020-05-21 21:58:38.598",
"Enabled": true
}
}
```
For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-event-subscription.html) in *AWS CLI Command Reference*.
### `delete-replication-instance`
The following code example shows how to use `delete-replication-instance`.
**AWS CLI**
**To delete a replication instance**
The following `delete-replication-instance` example deletes a replication instance.
```
aws dms delete-replication-instance \
--replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE
```
Output:
```
{
"ReplicationInstance": {
"ReplicationInstanceIdentifier": "my-repl-instance",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceStatus": "deleting",
"AllocatedStorage": 5,
"InstanceCreateTime": 1590011235.952,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-f839b688",
"Status": "active"
}
],
"AvailabilityZone": "us-east-1e",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "default",
"ReplicationSubnetGroupDescription": "default",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-42599426",
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-6746046b",
"SubnetAvailabilityZone": {
"Name": "us-east-1f"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-cbfff283",
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetStatus": "Active"
}
]
},
"PreferredMaintenanceWindow": "wed:11:42-wed:12:12",
"PendingModifiedValues": {},
"MultiAZ": true,
"EngineVersion": "3.3.2",
"AutoMinorVersionUpgrade": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"ReplicationInstancePublicIpAddress": "54.225.120.92",
"ReplicationInstancePrivateIpAddress": "172.31.30.121",
"ReplicationInstancePublicIpAddresses": [
"54.225.120.92",
"3.230.18.248"
],
"ReplicationInstancePrivateIpAddresses": [
"172.31.30.121",
"172.31.75.90"
],
"PubliclyAccessible": true,
"SecondaryAvailabilityZone": "us-east-1b"
}
}
```
For more information, see [Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-instance.html) in *AWS CLI Command Reference*.
### `delete-replication-subnet-group`
The following code example shows how to use `delete-replication-subnet-group`.
**AWS CLI**
**To delete a subnet group**
The following `delete-replication-subnet-group` example deletes a subnet group.
```
aws dms delete-replication-subnet-group \
--replication-subnet-group-identifier my-subnet-group
```
Output:
```
(none)
```
For more information, see [Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-subnet-group.html) in *AWS CLI Command Reference*.
### `delete-replication-task`
The following code example shows how to use `delete-replication-task`.
**AWS CLI**
**To delete a replication task**
The following `delete-replication-task` example deletes a replication task.
```
aws dms delete-replication-task \
--replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII
```
Output:
```
{
"ReplicationTask": {
"ReplicationTaskIdentifier": "moveit2",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"MigrationType": "full-load",
"TableMappings": ...output omitted...,
"ReplicationTaskSettings": ...output omitted...,
"Status": "deleting",
"StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
"ReplicationTaskCreationDate": 1590524772.505,
"ReplicationTaskStartDate": 1590789988.677,
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII"
}
}
```
For more information, see [Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DeleteReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-task.html) in *AWS CLI Command Reference*.
### `describe-account-attributes`
The following code example shows how to use `describe-account-attributes`.
**AWS CLI**
**To describe account attributes**
The following `describe-account-attributes` example lists the attributes for your AWS account.
```
aws dms describe-account-attributes
```
Output:
```
{
"AccountQuotas": [
{
"AccountQuotaName": "ReplicationInstances",
"Used": 1,
"Max": 20
},
{
"AccountQuotaName": "AllocatedStorage",
"Used": 5,
"Max": 10000
},
...remaining output omitted...
],
"UniqueAccountIdentifier": "cqahfbfy5xee"
}
```
+ For API details, see [DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-account-attributes.html) in *AWS CLI Command Reference*.
### `describe-certificates`
The following code example shows how to use `describe-certificates`.
**AWS CLI**
**To list the available certificates**
The following `describe-certificates` example lists the available certificates in your AWS account.
```
aws dms describe-certificates
```
Output:
```
{
"Certificates": [
{
"CertificateIdentifier": "my-cert",
"CertificateCreationDate": 1543259542.506,
"CertificatePem": "-----BEGIN CERTIFICATE-----\nMIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQ ...U"
... remaining output omittted ...
}
]
}
```
For more information, see [Using SSL](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.SSL) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-certificates.html) in *AWS CLI Command Reference*.
### `describe-connections`
The following code example shows how to use `describe-connections`.
**AWS CLI**
**To describe connections**
The following `describe-connections` example lists the connections that you have tested between a replication instance and an endpoint.
```
aws dms describe-connections
```
Output:
```
{
"Connections": [
{
"Status": "successful",
"ReplicationInstanceIdentifier": "test",
"EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
"EndpointIdentifier": "testsrc1",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
}
]
}
```
For more information, see [Creating Source and Target Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-connections.html) in *AWS CLI Command Reference*.
### `describe-endpoint-types`
The following code example shows how to use `describe-endpoint-types`.
**AWS CLI**
**To list the available endpoint types**
The following `describe-endpoint-types` example lists the MySQL endpoint types that are available.
```
aws dms describe-endpoint-types \
--filters "Name=engine-name,Values=mysql"
```
Output:
```
{
"SupportedEndpointTypes": [
{
"EngineName": "mysql",
"SupportsCDC": true,
"EndpointType": "source",
"EngineDisplayName": "MySQL"
},
{
"EngineName": "mysql",
"SupportsCDC": true,
"EndpointType": "target",
"EngineDisplayName": "MySQL"
}
]
}
```
For more information, see Working with AWS DMS Endpoints `\$1\$1 in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeEndpointTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoint-types.html) in *AWS CLI Command Reference*.
### `describe-endpoints`
The following code example shows how to use `describe-endpoints`.
**AWS CLI**
**To describe endpoints**
The following `describe-endpoints` example lists the endpoints in your AWS account.
```
aws dms describe-endpoints
```
Output:
```
{
"Endpoints": [
{
"Username": "dms",
"Status": "active",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:SF2WOFLWYWKVEOHID2EKLP3SJI",
"ServerName": "ec2-52-32-48-61.us-west-2.compute.amazonaws.com",
"EndpointType": "SOURCE",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/94d5c4e7-4e4c-44be-b58a-c8da7adf57cd",
"DatabaseName": "test",
"EngineName": "mysql",
"EndpointIdentifier": "pri100",
"Port": 8193
},
{
"Username": "admin",
"Status": "active",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:TJJZCIH3CJ24TJRU4VC32WEWFR",
"ServerName": "test.example.com",
"EndpointType": "SOURCE",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/2431021b-1cf2-a2d4-77b2-59a9e4bce323",
"DatabaseName": "EMPL",
"EngineName": "oracle",
"EndpointIdentifier": "test",
"Port": 1521
}
]
}
```
For more information, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoints.html) in *AWS CLI Command Reference*.
### `describe-event-categories`
The following code example shows how to use `describe-event-categories`.
**AWS CLI**
**To describe event categories**
The following `describe-event-categories` example lists the available event categories.
```
aws dms describe-event-categories
```
Output:
```
{
"EventCategoryGroupList": [
{
"SourceType": "replication-instance",
"EventCategories": [
"low storage",
"configuration change",
"maintenance",
"deletion",
"creation",
"failover",
"failure"
]
},
{
"SourceType": "replication-task",
"EventCategories": [
"configuration change",
"state change",
"deletion",
"creation",
"failure"
]
}
]
}
```
For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-categories.html) in *AWS CLI Command Reference*.
### `describe-event-subscriptions`
The following code example shows how to use `describe-event-subscriptions`.
**AWS CLI**
**To describe event subscriptions**
The following `describe-event-subscriptions` example lists the event subscriptions to an Amazon SNS topic.
```
aws dms describe-event-subscriptions
```
Output:
```
{
"EventSubscriptionsList": [
{
"CustomerAwsId": "123456789012",
"CustSubscriptionId": "my-dms-events",
"SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
"Status": "deleting",
"SubscriptionCreationTime": "2020-05-21 22:28:51.924",
"Enabled": true
}
]
}
```
For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-subscriptions.html) in *AWS CLI Command Reference*.
### `describe-events`
The following code example shows how to use `describe-events`.
**AWS CLI**
**To list DMS events**
The following `describe-events` example lists the events that originated from a replication instance.
```
aws dms describe-events \
--source-type "replication-instance"
```
Output:
```
{
"Events": [
{
"SourceIdentifier": "my-repl-instance",
"SourceType": "replication-instance",
"Message": "Replication application shutdown",
"EventCategories": [],
"Date": 1590771645.776
}
]
}
```
For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-events.html) in *AWS CLI Command Reference*.
### `describe-orderable-replication-instances`
The following code example shows how to use `describe-orderable-replication-instances`.
**AWS CLI**
**To describe orderable replication instances**
The following `describe-orderable-replication-instances` example lists replication instance types that you can order.
```
aws dms describe-orderable-replication-instances
```
Output:
```
{
"OrderableReplicationInstances": [
{
"EngineVersion": "3.3.2",
"ReplicationInstanceClass": "dms.c4.2xlarge",
"StorageType": "gp2",
"MinAllocatedStorage": 5,
"MaxAllocatedStorage": 6144,
"DefaultAllocatedStorage": 100,
"IncludedAllocatedStorage": 100,
"AvailabilityZones": [
"us-east-1a",
"us-east-1b",
"us-east-1c",
"us-east-1d",
"us-east-1e",
"us-east-1f"
]
},
{
"EngineVersion": "3.3.2",
"ReplicationInstanceClass": "dms.c4.4xlarge",
"StorageType": "gp2",
"MinAllocatedStorage": 5,
"MaxAllocatedStorage": 6144,
"DefaultAllocatedStorage": 100,
"IncludedAllocatedStorage": 100,
"AvailabilityZones": [
"us-east-1a",
"us-east-1b",
"us-east-1c",
"us-east-1d",
"us-east-1e",
"us-east-1f"
]
},
...remaining output omitted...
}
```
For more information, see [Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeOrderableReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-orderable-replication-instances.html) in *AWS CLI Command Reference*.
### `describe-refresh-schemas-status`
The following code example shows how to use `describe-refresh-schemas-status`.
**AWS CLI**
**To list the refresh status for an endpoint**
The following `describe-refresh-schemas-status` example returns the status of a previous refresh request.
```
aws dms describe-refresh-schemas-status \
--endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA
```
Output:
```
{
"RefreshSchemasStatus": {
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"Status": "successful",
"LastRefreshDate": 1590786544.605
}
}
```
+ For API details, see [DescribeRefreshSchemasStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-refresh-schemas-status.html) in *AWS CLI Command Reference*.
### `describe-replication-instances`
The following code example shows how to use `describe-replication-instances`.
**AWS CLI**
**To describe replication instances**
The following `describe-replication-instances` example lists the replication instances in your AWS account.
```
aws dms describe-replication-instances
```
Output:
```
{
"ReplicationInstances": [
{
"ReplicationInstanceIdentifier": "my-repl-instance",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceStatus": "available",
"AllocatedStorage": 5,
"InstanceCreateTime": 1590011235.952,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-f839b688",
"Status": "active"
}
],
"AvailabilityZone": "us-east-1e",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "default",
"ReplicationSubnetGroupDescription": "default",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-42599426",
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-6746046b",
"SubnetAvailabilityZone": {
"Name": "us-east-1f"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-cbfff283",
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetStatus": "Active"
}
]
},
"PreferredMaintenanceWindow": "wed:11:42-wed:12:12",
"PendingModifiedValues": {
"MultiAZ": true
},
"MultiAZ": false,
"EngineVersion": "3.3.2",
"AutoMinorVersionUpgrade": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"ReplicationInstancePublicIpAddress": "3.230.18.248",
"ReplicationInstancePrivateIpAddress": "172.31.75.90",
"ReplicationInstancePublicIpAddresses": [
"3.230.18.248"
],
"ReplicationInstancePrivateIpAddresses": [
"172.31.75.90"
],
"PubliclyAccessible": true,
"FreeUntil": 1590194829.267
}
]
}
```
For more information, see [Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-instances.html) in *AWS CLI Command Reference*.
### `describe-replication-subnet-groups`
The following code example shows how to use `describe-replication-subnet-groups`.
**AWS CLI**
**To display the available subnet groups**
The following `describe-replication-subnet-groups` example lists the available subnet groups.
```
aws dms describe-replication-subnet-groups \
--filter "Name=replication-subnet-group-id,Values=my-subnet-group"
```
Output:
```
{
"ReplicationSubnetGroups": [
{
"ReplicationSubnetGroupIdentifier": "my-subnet-group",
"ReplicationSubnetGroupDescription": "my subnet group",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
}
]
}
]
}
```
For more information, see [Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeReplicationSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-subnet-groups.html) in *AWS CLI Command Reference*.
### `describe-replication-task-assessment-results`
The following code example shows how to use `describe-replication-task-assessment-results`.
**AWS CLI**
**To list the results of replication task assessmentss**
The following `describe-replication-task-assessment-results` example lists the results of a prior task assesssment.
```
aws dms describe-replication-task-assessment-results
```
Output:
```
{
"ReplicationTaskAssessmentResults": [
{
"ReplicationTaskIdentifier": "moveit2",
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII",
"ReplicationTaskLastAssessmentDate": 1590790230.0,
"AssessmentStatus": "No issues found",
"AssessmentResultsFile": "moveit2/2020-05-29-22-10"
}
]
}
```
For more information, see [Creating a Task Assessment Report](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeReplicationTaskAssessmentResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-task-assessment-results.html) in *AWS CLI Command Reference*.
### `describe-replication-tasks`
The following code example shows how to use `describe-replication-tasks`.
**AWS CLI**
**To describe a replication task**
The following `describe-replication-tasks` example describes current replication tasks.
```
aws dms describe-replication-tasks
```
Output:
```
{
"ReplicationTasks": [
{
"ReplicationTaskIdentifier": "moveit2",
"SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
"TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"MigrationType": "full-load",
"TableMappings": ...output omitted... ,
"ReplicationTaskSettings": ...output omitted... ,
"Status": "stopped",
"StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
"ReplicationTaskCreationDate": 1590524772.505,
"ReplicationTaskStartDate": 1590619805.212,
"ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII",
"ReplicationTaskStats": {
"FullLoadProgressPercent": 100,
"ElapsedTimeMillis": 0,
"TablesLoaded": 0,
"TablesLoading": 0,
"TablesQueued": 0,
"TablesErrored": 0,
"FreshStartDate": 1590619811.528,
"StartDate": 1590619811.528,
"StopDate": 1590619842.068
}
}
]
}
```
For more information, see [Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeReplicationTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-tasks.html) in *AWS CLI Command Reference*.
### `describe-schemas`
The following code example shows how to use `describe-schemas`.
**AWS CLI**
**To describe database schemas**
The following `describe-schemas` example lists the available tables at an endpoint.
```
aws dms describe-schemas \
--endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA"
```
Output:
```
{
"Schemas": [
"prodrep"
]
}
```
For more information, see [This is the topic title](https://link.to.the/topic/page) in the *AWS Database Migration Service User Guide*.
+ For API details, see [DescribeSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-schemas.html) in *AWS CLI Command Reference*.
### `list-tags-for-resource`
The following code example shows how to use `list-tags-for-resource`.
**AWS CLI**
**To list the tags for a resource**
The following `list-tags-for-resource` example lists the tags for a replication instance.
```
aws dms list-tags-for-resource \
--resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE
```
Output:
```
{
"TagList": [
{
"Key": "Project",
"Value": "dbMigration"
},
{
"Key": "Environment",
"Value": "PROD"
}
]
}
```
For more information, see [Tagging Resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) in the *AWS Database Migration Service User Guide*.
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/list-tags-for-resource.html) in *AWS CLI Command Reference*.
### `modify-endpoint`
The following code example shows how to use `modify-endpoint`.
**AWS CLI**
**To modify an endpoint**
The following `modify-endpoint` example adds an extra connection attribute to an endpoint.
```
aws dms modify-endpoint \
--endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U" \
--extra-connection-attributes "compressionType=GZIP"
```
Output:
```
{
"Endpoint": {
"EndpointIdentifier": "src-endpoint",
"EndpointType": "SOURCE",
"EngineName": "s3",
"EngineDisplayName": "Amazon S3",
"ExtraConnectionAttributes": "compressionType=GZIP;csvDelimiter=,;csvRowDelimiter=\\n;",
"Status": "active",
"EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U",
"SslMode": "none",
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"S3Settings": {
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3-access-role",
"CsvRowDelimiter": "\\n",
"CsvDelimiter": ",",
"BucketFolder": "",
"BucketName": "",
"CompressionType": "GZIP",
"EnableStatistics": true
}
}
}
```
For more information, see Working with AWS DMS Endpoints `\$1\$1 in the *AWS Database Migration Service User Guide*.
+ For API details, see [ModifyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-endpoint.html) in *AWS CLI Command Reference*.
### `modify-event-subscription`