기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# describeImage
<a name="describe-image"></a>

기존 이미지에 대한 세부 정보를 가져옵니다.

**Topics**
+ [요청 구문](#describe-image-request)
+ [요청 본문](#describe-image-request-body)
+ [응답 구문](#describe-image-response)
+ [응답 본문](#describe-image-response-body)
+ [예제](#describe-image-example)

## 요청 구문
<a name="describe-image-request"></a>

```
GET /v3/images/custom/{imageId}
{
  "region": "string"
}
```

## 요청 본문
<a name="describe-image-request-body"></a>

**imageId**  
이미지의 ID입니다.  
유형: string  
필수 항목 여부: 예

**리전**  
이미지가 생성된 AWS 리전 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="describe-image-response"></a>

```
{
  "imageId": "string",
  "region": "string",
  "version": "string",
  "imageBuildStatus": "BUILD_IN_PROGRESS",
  "imageBuildLogsArn": "string",
  "cloudformationStackStatus": "CREATE_IN_PROGRESS",
  "cloudformationStackStatusReason": "string",
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackCreationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackTags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "imageConfiguration": {
    "url": "string"
  },
  "imagebuilderImageStatus": "PENDING",
  "imagebuilderImageStatusReason": "string",
  "ec2AmiInfo": {
    "amiId": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "amiName": "string",
    "architecture": "string",
    "state": "PENDING",
    "description": "string"
  }
}
```

## 응답 본문
<a name="describe-image-response-body"></a>

**imageId**  
세부 정보를 검색할 이미지의 ID입니다.  
유형: string

**imageBuildStatus**  
이미지 빌드 상태입니다.  
유형: string  
유효값: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`

**imageConfiguration**    
**url**  
이미 구성 파일의 URL입니다.  
유형: string

**리전**  
이미지가 생성되는 AWS 리전 입니다.  
유형: string

**version**  
이미지를 빌드하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string

**cloudformationStackCreationTime**  
CloudFormation 스택이 생성된 시간입니다.  
유형: 날짜/시간

**cloudformationStackStatus**  
CloudFormation 스택 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE`

**cloudformationStackStatusReason**  
CloudFormation 스택 상태의 이유입니다.  
유형: string

**cloudformationStackTags**  
CloudFormation 스택의 태그 목록입니다.    
**키**  
태그 이름입니다.  
유형: string  
**값**  
태그 값입니다.  
유형: string

**creationTime**  
이미지가 생성된 시간입니다.  
유형: 날짜/시간

**ec2AmiInfo**    
**amiId**  
Amazon EC2 AMI ID.  
유형: string  
**amiName**  
Amazon EC2 AMI 이름입니다.  
유형: string  
**architecture**  
Amazon EC2 AMI 아키텍처입니다.  
유형: string  
**state**  
Amazon EC2 AMI의 상태입니다.  
유형: string  
유효값: `PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`  
**tags**  
Amazon EC2 AMI 태그의 목록입니다.    
**키**  
태그 이름입니다.  
유형: string  
**값**  
태그 값입니다.  
유형: string

**imagebuilderImageStatus**  
ImageBuilder 이미지 상태입니다.  
유형: string  
유효값: `PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`

**imagebuilderImageStatusReason**  
ImageBuilder 이미지에 해당 상태가 있는 이유입니다.  
유형: string

**imageBuildLogsArn**  
이미지 빌드 프로세스에 대한 로그의 Amazon 리소스 이름(ARN)입니다.  
유형: string

## 예제
<a name="describe-image-example"></a>

------
#### [ Python ]

**요청**

```
$ describe_image(custom-image-id)
```

**200 응답**

```
{
  "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/6accc570-b080-11ec-845e-0e2dc6386985",
  "cloudformation_stack_creation_time": datetime.datetime(2022, 3, 30, 23, 23, 33, 731000, tzinfo=tzlocal()),
  "cloudformation_stack_status": "CREATE_IN_PROGRESS",
  "cloudformation_stack_tags": [
    {
      "key": "parallelcluster:version", "value": "3.2.1"
    },
    {
      "key": "parallelcluster:image_name",
      "value": 'custom-image-id"
    },
    {
      "key": "parallelcluster:custom-image-id",
      "value": "custom-image-id"
    },
    {
      "key": 'parallelcluster:amzn-s3-demo-bucket",
      "value": 'amzn-s3-demo-bucket"
    },
    {
      "key": "parallelcluster:s3_image_dir",
      "value": "parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0"
    },
    {
      "key": "parallelcluster:build_log",
      "value": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-custom-image-id"
    },
    {
      "key": "parallelcluster:build_config",
      "value": "s3://amzn-s3-demo-bucket/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml"
    }
  ],
  "image_build_logs_arn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image",
  "image_build_status": "BUILD_IN_PROGRESS",
  "image_configuration": {
    "url": "https://amzn-s3-demo-bucket.s3.amazonaws.com/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml?..."
  },
  "image_id": 'custom-image-id',
  "imagebuilder_image_status": "PENDING",
  "region": "us-east-1",
  "version": "3.2.1"
}
```

------