Skip to main content
Version: latest

Returns AWS image for the specified AMI name

POST 
/v1/clouds/aws/regions/:region/images

Returns AWS image for the specified AMI name

Request​

Path Parameters

    region stringrequired

    Region to find AWS image

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

Request payload to find the AWS image

    amiNamestring

    AWS image ami name

    awsAccount

    object

    AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

    accessKeystring

    AWS account access key

    credentialTypestring

    Possible values: [secret, sts]

    Default value: secret

    Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

    partitionstring

    Possible values: [aws, aws-us-gov]

    Default value: aws

    AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

    policyARNsstring[]

    List of policy ARNs required in case of credentialType sts.

    secretKeystring

    AWS account secret key

    sts

    object

    Aws sts credentials

    arnstring

    Arn for the aws sts credentials in cloud account

    externalIdstring

    ExternalId for the aws sts credentials in cloud account

Responses​

(empty)

Schema

    idstring

    AWS image id

    namestring

    AWS image name

    ownerstring

    AWS image owner id

Loading...