|
497 | 497 | {"shape":"InvalidInputException"}, |
498 | 498 | {"shape":"ResourceNotFoundException"} |
499 | 499 | ], |
500 | | - "documentation":"<p>Restarts a batch build.</p>" |
| 500 | + "documentation":"<p>Restarts a failed batch build. Only batch builds that have failed can be retried.</p>" |
501 | 501 | }, |
502 | 502 | "StartBuild":{ |
503 | 503 | "name":"StartBuild", |
|
2766 | 2766 | }, |
2767 | 2767 | "modes":{ |
2768 | 2768 | "shape":"ProjectCacheModes", |
2769 | | - "documentation":"<p> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. </p> <ul> <li> <p> <code>LOCAL_SOURCE_CACHE</code> mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </p> </li> <li> <p> <code>LOCAL_DOCKER_LAYER_CACHE</code> mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p> You can use a Docker layer cache in the Linux environment only. </p> </li> <li> <p> The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </p> </li> <li> <p> You should consider the security implications before you use a Docker layer cache. </p> </li> </ul> </note> </li> </ul> <ul> <li> <p> <code>LOCAL_CUSTOM_CACHE</code> mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p> Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p> Symlinks are used to reference cached directories. </p> </li> <li> <p> Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </li> </ul>" |
| 2769 | + "documentation":"<p>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</p> <p>Possible values are:</p> <dl> <dt>LOCAL_SOURCE_CACHE</dt> <dd> <p>Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </p> </dd> <dt>LOCAL_DOCKER_LAYER_CACHE</dt> <dd> <p>Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p>You can use a Docker layer cache in the Linux environment only. </p> </li> <li> <p>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </p> </li> <li> <p>You should consider the security implications before you use a Docker layer cache. </p> </li> </ul> </note> </dd> <dt>LOCAL_CUSTOM_CACHE</dt> <dd> <p>Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p>Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p>Symlinks are used to reference cached directories. </p> </li> <li> <p>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </dd> </dl>" |
2770 | 2770 | } |
2771 | 2771 | }, |
2772 | 2772 | "documentation":"<p>Information about the cache for the build project.</p>" |
|
2794 | 2794 | }, |
2795 | 2795 | "image":{ |
2796 | 2796 | "shape":"NonEmptyString", |
2797 | | - "documentation":"<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. To specify the latest version of this image, this would be <code>aws/codebuild/standard:latest</code>.</p> </li> <li> <p>For an image digest: <code><registry>/<repository>@<digest></code>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul>" |
| 2797 | + "documentation":"<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code><registry>/<repository>@<digest></code>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul>" |
2798 | 2798 | }, |
2799 | 2799 | "computeType":{ |
2800 | 2800 | "shape":"ComputeType", |
|
2810 | 2810 | }, |
2811 | 2811 | "certificate":{ |
2812 | 2812 | "shape":"String", |
2813 | | - "documentation":"<p>The certificate to use with this build project.</p>" |
| 2813 | + "documentation":"<p>The ARN of the Amazon Simple Storage Service (Amazon S3) bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate\">certificate</a> in the <i>AWS CodeBuild User Guide</i>.</p>" |
2814 | 2814 | }, |
2815 | 2815 | "registryCredential":{ |
2816 | 2816 | "shape":"RegistryCredential", |
|
2832 | 2832 | }, |
2833 | 2833 | "location":{ |
2834 | 2834 | "shape":"String", |
2835 | | - "documentation":"<p> A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p> The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>" |
| 2835 | + "documentation":"<p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>" |
2836 | 2836 | }, |
2837 | 2837 | "mountPoint":{ |
2838 | 2838 | "shape":"String", |
2839 | | - "documentation":"<p> The location in the container where you mount the file system. </p>" |
| 2839 | + "documentation":"<p>The location in the container where you mount the file system. </p>" |
2840 | 2840 | }, |
2841 | 2841 | "identifier":{ |
2842 | 2842 | "shape":"String", |
2843 | | - "documentation":"<p> The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my-efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY-EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>" |
| 2843 | + "documentation":"<p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>" |
2844 | 2844 | }, |
2845 | 2845 | "mountOptions":{ |
2846 | 2846 | "shape":"String", |
|
3126 | 3126 | "tags":{ |
3127 | 3127 | "shape":"TagList", |
3128 | 3128 | "documentation":"<p> A list of tag key and value pairs associated with this report group. </p> <p>These tags are available for use by AWS services that support AWS CodeBuild report group tags.</p>" |
3129 | | - } |
| 3129 | + }, |
| 3130 | + "status":{"shape":"ReportGroupStatusType"} |
3130 | 3131 | }, |
3131 | 3132 | "documentation":"<p> A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files. </p>" |
3132 | 3133 | }, |
|
3149 | 3150 | "LAST_MODIFIED_TIME" |
3150 | 3151 | ] |
3151 | 3152 | }, |
| 3153 | + "ReportGroupStatusType":{ |
| 3154 | + "type":"string", |
| 3155 | + "enum":[ |
| 3156 | + "ACTIVE", |
| 3157 | + "DELETING" |
| 3158 | + ] |
| 3159 | + }, |
3152 | 3160 | "ReportGroups":{ |
3153 | 3161 | "type":"list", |
3154 | 3162 | "member":{"shape":"ReportGroup"}, |
|
0 commit comments