AWS.Tools.ECR.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ECR</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRLoginCommandCmdlet"> <summary> <para> Retrieves a token that is valid for a specified registry for 12 hours and outputs a PSObject containing the decoded username, password, proxy endpoint and token expiry data, plus a pre-formatted docker login command utilizing those fields that you can execute to log in to your registry with Docker. After you have logged in to an Amazon ECR registry with this command, you can use the Docker CLI to push and pull images from that registry until the token expires. </para> <para> The credentials and region required to call the service to obtain the authorization token(s) can be specified using parameters to the cmdlet or will be obtained from the shell-default user credential profile and region. </para> <para> <br/><br/> <b>NOTE:</b> This command writes objects to the pipeline containing authentication credentials. Your credentials could be visible by other users on your system in a process list display or a command history. If you are not on a secure system, you should consider this risk and login interactively. </para> <para> For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetAuthorizationToken.html">GetAuthorizationToken</a> and <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html">What Is Amazon EC2 Container Registry?</a>in the Amazon EC2 Container Registry documentation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLoginCommandCmdlet.RegistryId"> <summary> <para> Optional collection of one or more AWS account IDs associated with the registries for which to get authorization tokens and login commands. If you do not specify any IDs, a single login command for your default registry is output. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet"> <summary> Uploads an image layer part to Amazon ECR. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.LayerPartBlob"> <summary> The layer part payload as text. The supplied value will be encoded as a base-64 string by the cmdlet prior to upload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.LayerPartBytes"> <summary> The layer part payload as a byte array. The supplied value will be encoded as a base-64 string by the cmdlet prior to upload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.LayerPartStream"> <summary> The base64-encoded layer part payload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.PartFirstByte"> <summary> <para> <para>The integer value of the first byte of the layer part.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.PartLastByte"> <summary> <para> <para>The integer value of the last byte of the layer part.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that you are uploading layer parts to. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository that you are uploading layer parts to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.UploadId"> <summary> <para> <para>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the layer part upload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SendECRLayerPartCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.AddECRResourceTagCmdlet"> <summary> Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.AddECRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.AddECRResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.AddECRResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.AddECRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet"> <summary> Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of the image layer for data validation purposes. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet.LayerDigest"> <summary> <para> <para>The <code>sha256</code> digest of the image layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to associate with the image layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet.UploadId"> <summary> <para> <para>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the image layer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.CompleteECRLayerUploadCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRAuthorizationTokenCmdlet"> <summary> Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the <code>docker</code> CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed. <para> The <code>authorizationToken</code> returned for each registry specified is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The AWS CLI offers an <code>aws ecr get-login</code> command that simplifies the login process. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRAuthorizationTokenCmdlet.RegistryId"> <summary> <para> <para>A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRDownloadUrlForLayerCmdlet"> <summary> Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRDownloadUrlForLayerCmdlet.LayerDigest"> <summary> <para> <para>The digest of the image layer to download.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRDownloadUrlForLayerCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRDownloadUrlForLayerCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository that is associated with the image layer to download.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet"> <summary> Lists all the image IDs for a given repository. <para> You can filter images based on whether or not they are tagged by setting the <code>tagStatus</code> parameter to <code>TAGGED</code> or <code>UNTAGGED</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet.RepositoryName"> <summary> <para> <para>The repository with image IDs to be listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet.Filter_TagStatus"> <summary> <para> <para>The tag status with which to filter your <a>ListImages</a> results. You can filter results based on whether they are <code>TAGGED</code> or <code>UNTAGGED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet.MaxResult"> <summary> <para> <para>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRImageBatchCmdlet"> <summary> Gets detailed information for specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageBatchCmdlet.AcceptedMediaType"> <summary> <para> <para>The accepted media types for the request.</para><para>Valid values: <code>application/vnd.docker.distribution.manifest.v1+json</code> | <code>application/vnd.docker.distribution.manifest.v2+json</code> | <code>application/vnd.oci.image.manifest.v1+json</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageBatchCmdlet.ImageId"> <summary> <para> <para>A list of image ID references that correspond to images to describe. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageBatchCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageBatchCmdlet.RepositoryName"> <summary> <para> <para>The repository that contains the images to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet"> <summary> Returns metadata about the images in a repository, including image size, image tags, and creation date. <note><para> Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>. </para></note><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.ImageId"> <summary> <para> <para>The list of image IDs for the requested repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.RepositoryName"> <summary> <para> <para>The repository that contains the images to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.Filter_TagStatus"> <summary> <para> <para>The tag status with which to filter your <a>DescribeImages</a> results. You can filter results based on whether they are <code>TAGGED</code> or <code>UNTAGGED</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of repository results returned by <code>DescribeImages</code> in paginated output. When this parameter is used, <code>DescribeImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribeImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify images with <code>imageIds</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRImageMetadataCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>DescribeImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify images with <code>imageIds</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRLayerAvailabilityBatchCmdlet"> <summary> Check the availability of multiple image layers in a specified registry and repository. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLayerAvailabilityBatchCmdlet.LayerDigest"> <summary> <para> <para>The digests of the image layers to check.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLayerAvailabilityBatchCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLayerAvailabilityBatchCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository that is associated with the image layers to check.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyCmdlet"> <summary> Retrieves the specified lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet"> <summary> Retrieves the results of the specified lifecycle policy preview request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.ImageId"> <summary> <para> <para>The list of imageIDs to be included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.Filter_TagStatus"> <summary> <para> <para>The tag status of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.MaxResult"> <summary> <para> <para>The maximum number of repository results returned by <code>GetLifecyclePolicyPreviewRequest</code> in paginated output. When this parameter is used, <code>GetLifecyclePolicyPreviewRequest</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>GetLifecyclePolicyPreviewRequest</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>GetLifecyclePolicyPreviewRequest</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify images with <code>imageIds</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRLifecyclePolicyPreviewCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>GetLifecyclePolicyPreviewRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify images with <code>imageIds</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryCmdlet"> <summary> Describes image repositories in a registry.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryCmdlet.RepositoryName"> <summary> <para> <para>A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of repository results returned by <code>DescribeRepositories</code> in paginated output. When this parameter is used, <code>DescribeRepositories</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeRepositories</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribeRepositories</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify repositories with <code>repositoryNames</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>DescribeRepositories</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify repositories with <code>repositoryNames</code>.</para><note><para>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryPolicyCmdlet"> <summary> Retrieves the repository policy for a specified repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryPolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRRepositoryPolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository with the policy to retrieve.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.GetECRResourceTagCmdlet"> <summary> List the tags for an Amazon ECR resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.GetECRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.NewECRRepositoryCmdlet"> <summary> Creates an image repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.NewECRRepositoryCmdlet.ImageTagMutability"> <summary> <para> <para>The tag mutability setting for the repository. If this parameter is omitted, the default setting of <code>MUTABLE</code> will be used which will allow image tags to be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.NewECRRepositoryCmdlet.RepositoryName"> <summary> <para> <para>The name to use for the repository. The repository name may be specified on its own (such as <code>nginx-web-app</code>) or it can be prepended with a namespace to group the repository into a category (such as <code>project-a/nginx-web-app</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.NewECRRepositoryCmdlet.Tag"> <summary> <para> <para>The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.NewECRRepositoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.RemoveECRImageBatchCmdlet"> <summary> Deletes a list of specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>. <para> You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. </para><para> You can completely delete an image (and all of its tags) by specifying the image's digest in your request. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRImageBatchCmdlet.ImageId"> <summary> <para> <para>A list of image ID references that correspond to images to delete. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRImageBatchCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRImageBatchCmdlet.RepositoryName"> <summary> <para> <para>The repository that contains the image to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRImageBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.RemoveECRLifecyclePolicyCmdlet"> <summary> Deletes the specified lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRLifecyclePolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRLifecyclePolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryCmdlet"> <summary> Deletes an existing image repository. If a repository contains images, you must use the <code>force</code> option to delete it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryCmdlet.IgnoreExistingImages"> <summary> <para> <para> If a repository contains images, forces the deletion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryPolicyCmdlet"> <summary> Deletes the repository policy from a specified repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryPolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryPolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository that is associated with the repository policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRRepositoryPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.RemoveECRResourceTagCmdlet"> <summary> Deletes specified tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.RemoveECRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet"> <summary> Applies a repository policy on a specified repository to control access permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html">Amazon ECR Repository Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet.OverridePolicy"> <summary> <para> <para>If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the <a>SetRepositoryPolicy</a> operation. This is intended to prevent accidental repository lock outs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet.PolicyText"> <summary> <para> <para>The JSON repository policy text to apply to the repository. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html">Amazon ECR Repository Policy Examples</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to receive the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.SetECRRepositoryPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.StartECRLayerUploadCmdlet"> <summary> Notify Amazon ECR that you intend to upload an image layer. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLayerUploadCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLayerUploadCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to which you intend to upload layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLayerUploadCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.StartECRLifecyclePolicyPreviewCmdlet"> <summary> Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLifecyclePolicyPreviewCmdlet.LifecyclePolicyText"> <summary> <para> <para>The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLifecyclePolicyPreviewCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLifecyclePolicyPreviewCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to be evaluated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.StartECRLifecyclePolicyPreviewCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet"> <summary> Creates or updates the image manifest and tags associated with an image. <note><para> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet.ImageManifest"> <summary> <para> <para>The image manifest corresponding to the image to be uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet.ImageTag"> <summary> <para> <para>The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository in which to put the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageTagMutabilityCmdlet"> <summary> Updates the image tag mutability settings for a repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageTagMutabilityCmdlet.ImageTagMutability"> <summary> <para> <para>The tag mutability setting for the repository. If <code>MUTABLE</code> is specified, image tags can be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageTagMutabilityCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageTagMutabilityCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository in which to update the image tag mutability settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRImageTagMutabilityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ECR.WriteECRLifecyclePolicyCmdlet"> <summary> Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html">Lifecycle Policy Template</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRLifecyclePolicyCmdlet.LifecyclePolicyText"> <summary> <para> <para>The JSON repository policy text to apply to the repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRLifecyclePolicyCmdlet.RegistryId"> <summary> <para> <para>The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRLifecyclePolicyCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository to receive the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ECR.WriteECRLifecyclePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |