A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/powershell/latest/reference/items/Get-EC2Image.html below:

EC2: Get-EC2Image Cmdlet | AWS Tools for PowerShell

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Calls the Amazon Elastic Compute Cloud (EC2) DescribeImages API operation.

Get-EC2Image

-ImageId <String[]>

-Owner <String[]>

-ExecutableUser <String[]>

-Filter <Filter[]>

-DryRun <Boolean>

-IncludeDeprecated <Boolean>

-IncludeDisabled <Boolean>

-MaxResult <Int32>

-NextToken <String>

-Select <String>

-NoAutoIteration <SwitchParameter>

-ClientConfig <AmazonEC2Config>

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you. The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions. Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found. When Allowed AMIs is set to

enabled

, only allowed images are returned in the results, with the

imageAllowed

field set to

true

for each image. In

audit-mode

, the

imageAllowed

field is set to

true

for images that meet the account's Allowed AMIs criteria, and

false

for images that don't meet the criteria. For more information, see

Allowed AMIs

. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see

Eventual consistency in the Amazon EC2 API

in the

Amazon EC2 Developer Guide

.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID,

self

(the sender of the request), or

all

(public AMIs).

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? 3 Accept pipeline input? True (ByPropertyName) Aliases ExecutableBy, ExecutableUsers

The filters.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? 4 Accept pipeline input? True (ByPropertyName) Aliases Filters

The image IDs.Default: Describes all images available to you. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? 1 Accept pipeline input? True (ByValue, ByPropertyName) Aliases ImageIds

Specifies whether to include deprecated AMIs.Default: No deprecated AMIs are included in the response.If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Specifies whether to include disabled AMIs.Default: No disabled AMIs are included in the response.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see

Pagination

.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases MaxResults

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, self , amazon , aws-backup-vault , and aws-marketplace . If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Required? False Position? 2 Accept pipeline input? True (ByPropertyName) Aliases Owners

Use the -Select parameter to control the cmdlet output. The default value is 'Images'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeImagesResponse). Specifying the name of a property of type Amazon.EC2.Model.DescribeImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

Common Credential and Region Parameters

The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases AK

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

Required? False Position? Named Accept pipeline input? True (ByValue, ByPropertyName)

The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False Position? Named Accept pipeline input? True (ByPropertyName)

-NetworkCredential <PSCredential>

Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.

Required? False Position? Named Accept pipeline input? True (ByValue, ByPropertyName)

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases AWSProfilesLocation, ProfilesLocation

The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases StoredCredentials, AWSProfileName

-Region <Object>

The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases RegionToCall

The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases SK, SecretAccessKey

The session token if the access and secret keys are temporary session-based credentials.

Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases ST

This cmdlet returns a collection of Amazon.EC2.Model.Image objects. The service call response (type Amazon.EC2.Model.DescribeImagesResponse) can be returned by specifying '-Select *'.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4