

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

# AWS ParallelCluster API 참조
<a name="api-ref-v3"></a>

이 섹션에는 각 AWS ParallelCluster API 작업에 대한 설명, 구문 및 사용 예제가 나와 있습니다.

**Topics**
+ [buildImage](build-image.md)
+ [createCluster](create-cluster.md)
+ [deleteCluster](delete-cluster.md)
+ [deleteClusterInstances](delete-cluster-instances.md)
+ [deleteImage](delete-image.md)
+ [describeCluster](describe-cluster.md)
+ [describeClusterInstances](describe-cluster-instances.md)
+ [describeComputeFleet](describe-compute-fleet.md)
+ [describeImage](describe-image.md)
+ [getClusterLogEvents](get-cluster-log-events.md)
+ [getClusterStackEvents](get-cluster-stack-events.md)
+ [getImageLogEvents](get-image-log-events.md)
+ [getImageStackEvents](get-image-stack-events.md)
+ [listClusters](list-clusters.md)
+ [listClusterLogStreams](list-cluster-log-streams.md)
+ [listImageLogStreams](list-image-log-streams.md)
+ [listImages](list-images.md)
+ [listOfficialImages](list-official-images.md)
+ [updateCluster](update-cluster.md)
+ [컴퓨팅 플릿 업데이트](update-compute-fleet.md)

# buildImage
<a name="build-image"></a>

에서 사용자 지정 AWS ParallelCluster 이미지를 생성합니다 AWS 리전.

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

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

```
POST /v3/images/custom
{
  "imageConfiguration": "string",
  "imageId": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure": boolean,
  "supressValidators": [ "string" ],
  "validationFailureLevel": "string"
}
```

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

**imageConfiguration**  
YAML 문서로서의 이미지 구성입니다.  
유형: string  
필수 항목 여부: 예

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

**dryrun**  
`true`로 설정하면 리소스를 만들지 않고 요청 검증만 수행합니다. 이 파라미터를 사용하여 이미지 구성을 확인합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**region**  
명령을 실행하여 이미지를 빌드 AWS 리전 하는 입니다.  
유형: string  
필수 항목 여부: 아니요

**rollbackOnFailure**  
`true`로 설정하면 이미지 생성에 실패할 경우 이미지 스택 롤백이 발생합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**suppressValidators**  
억제할 구성 유효성 검사기를 하나 이상 식별하세요.  
유형: 문자열 목록  
형식: `(ALL|type:[A-Za-z0-9]+)`  
필수 여부: 아니요

**validationFailureLevel**  
이미지 빌드 실패를 유발하는 최소 검증 수준입니다. 기본값은 `ERROR`입니다.  
유형: string  
유효값: `INFO | WARNING | ERROR`  
필수 항목 여부: 아니요

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

```
{
  "image": {
    "imageId": "string",
    "ec2AmiInfo": {
      "amiId": "string"
    },
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "imageBuildStatus": "BUILD_IN_PROGRESS",
    "cloudformationStackStatus": "CREATE_IN_PROGRESS"
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ]
}
```

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

**image**    
**imageId**  
이미지의 ID입니다.  
유형: string  
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**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`  
**ec2AmiInfo**    
**ami\$1id**  
Amazon EC2 AMI ID.  
유형: string  
**imageBuildStatus**  
이미지 빌드 상태입니다.  
유형: string  
유효값: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**리전**  
이미지가 빌드되는 AWS 리전 입니다.  
유형: string  
**version**  
이미지를 빌드하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**validationMessages**  
검증 수준이 `validationFailureLevel`보다 낮은 메시지 목록입니다. 메시지 목록은 구성 검증 중에 수집됩니다.    
**id**  
검사기의 ID입니다.  
유형: string  
**level**  
검증 수준입니다.  
유형: string  
유효값: `INFO | WARNING | ERROR`  
**message**  
확인 메시지입니다.  
유형: string  
**type**  
검사기의 유형입니다.  
유형: string

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

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

**요청**

```
$ build_image(custom-image-id, custom-image-config.yaml)
```

**200 응답**

```
{
  "image": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/711b76b0-af81-11ec-a29f-0ee549109f1f",
    "cloudformation_stack_status": "CREATE_IN_PROGRESS",
    "image_build_status": "BUILD_IN_PROGRESS",
    "image_id": "custom-image-id",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------

# createCluster
<a name="create-cluster"></a>

 AWS 리전에서 관리형 클러스터를 생성하세요.

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

## 요청 구문
<a name="create-cluster-request"></a>

```
POST /v3/clusters
{
  "clusterName": "string",
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure", boolean,
  "suppressValidators": [ "string" ],
  "validationFailureLevel": "string"
}
```

## 요청 본문
<a name="create-cluster-request-body"></a>

**clusterConfiguration**  
YAML 문서로서의 클러스터 구성입니다.  
유형: string  
필수 항목 여부: 예

**clusterName**  
생성할 클러스터의 이름입니다.  
이름은 영문자로 시작해야 합니다. 계획 이름은 최대 60자까지 가능합니다. Slurm 회계가 활성화된 경우 이름은 최대 40자까지 사용할 수 있습니다.  
유형: string  
필수 항목 여부: 예

**dryrun**  
로 설정된 경우 요청 검증`true`만 수행하고 리소스를 생성하지 마십시오. 이 파라미터를 사용하여 클러스터 구성을 확인합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수 항목 여부: 아니요

**rollbackOnFailure**  
`true`로 설정하면 클러스터 생성에 실패할 경우 클러스터 스택 롤백이 발생합니다. 기본값은 `true`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**suppressValidators**  
억제할 구성 유효성 검사기를 하나 이상 식별하세요.  
유형: 문자열 목록  
형식: `(ALL|type:[A-Za-z0-9]+)`  
필수 여부: 아니요

**validationFailureLevel**  
클러스터 생성 실패를 유발하는 최소 검증 수준입니다. 기본값은 `ERROR`입니다.  
유형: string  
유효값: `INFO | WARNING | ERROR`  
필수 항목 여부: 아니요

## 응답 구문
<a name="create-cluster-response"></a>

```
{
  "cluster": {
    "clusterName": "string",
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "cloudformationStackStatus": "CREATE_IN_PROGRESS",
    "clusterStatus": "CREATE_IN_PROGRESS",
    "scheduler": {
      "type": "string",
      "metadata": {
        "name": "string",
        "version": "string"
      }
    }
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ]
}
```

## 응답 본문
<a name="create-cluster-response-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string

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

**cloudformationStackStatus**  
유형: 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`

**clusterStatus**  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`

**리전**  
클러스터 AWS 리전 가 생성되는 입니다.  
유형: string

**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string  
**type**  
스케줄러의 유형입니다.  
유형: string

**version**  
클러스터를 생성하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**validation\$1messages**  
검증 수준이 `validationFailureLevel`보다 낮은 메시지 목록입니다. 메시지 목록은 구성 검증 중에 수집됩니다.    
**id**  
검사기의 ID입니다.  
유형: string  
**level**  
유형: string  
유효값: `INFO | WARNING | ERROR`  
**message**  
확인 메시지입니다.  
유형: string  
**type**  
검사기의 유형입니다.  
유형: string

## 예제
<a name="create-cluster-example"></a>

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

**요청**

```
$ create_cluster(cluster_name_3x, cluster-config.yaml)
```

**200 응답**

```
{
  "cluster": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-3x/e0462730-50b5-11ed-99a3-0a5ddc4a34c7",
    "cloudformation_stack_status": "CREATE_IN_PROGRESS",
    "cluster_name": "cluster-3x",
    "cluster_status": "CREATE_IN_PROGRESS",
    "region": "us-east-1",
    "scheduler": {
      "type": "slurm"
    },
    "version": "3.2.1"
  }
}
```

------

# deleteCluster
<a name="delete-cluster"></a>

클러스터 삭제를 시작합니다.

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

## 요청 구문
<a name="delete-cluster-request"></a>

```
DELETE /v3/clusters/{clusterName}
{
  "region": "string"
}
```

## 요청 본문
<a name="delete-cluster-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**리전**  
클러스터가 삭제되는 AWS 리전 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="delete-cluster-response"></a>

```
{
   "cluster": {
       "clusterName": "string",
       "region": "string",
       "version": "string",
       "cloudformationStackArn": "string",
       "cloudformationStackStatus": "DELETE_IN_PROGRESS",
       "clusterStatus": "DELETE_IN_PROGRESS",
       "scheduler": {
           "type": "string",
           "metadata": {
               "name": "string",
               "version": "string"
           }
        }
    }
}
```

## 응답 본문
<a name="delete-cluster-response-body"></a>

**클러스터**  
클러스터 인스턴스 목록입니다.    
**clusterName**  
클러스터의 이름입니다.  
유형: string  
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**cloudformationStackStatus**  
유형: 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`  
**clusterStatus**  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**리전**  
클러스터가 생성되는 AWS 리전 입니다.  
유형: string  
**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string  
**type**  
스케줄러의 유형입니다.  
유형: string  
**version**  
클러스터를 생성하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

## 예제
<a name="delete-cluster-example"></a>

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

**요청**

```
$ delete_cluster(cluster_name_3x)
```

**200 응답**

```
{
  "cluster": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
    "cloudformation_stack_status": "DELETE_IN_PROGRESS",
    "cluster_name": "cluster_name_3x",
    "cluster_status": "DELETE_IN_PROGRESS",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------

# deleteClusterInstances
<a name="delete-cluster-instances"></a>

모든 클러스터 컴퓨팅 노드의 강제 종료를 시작합니다. 이 작업은 AWS Batch 클러스터를 지원하지 않습니다.

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

## 요청 구문
<a name="delete-cluster-instances-request"></a>

```
DELETE /v3/clusters/{clusterName}/instances
{
  "force": boolean,
  "region": "string"
}
```

## 요청 본문
<a name="delete-cluster-instances-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**force**  
`true`로 설정하면 지정된 이름의 클러스터를 찾을 수 없을 때 강제로 삭제합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수 항목 여부: 아니요

## 응답 본문
<a name="delete-cluster-instances-response-body"></a>

없음

## 예제
<a name="delete-cluster-instances-example"></a>

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

**요청**

```
$ delete_cluster_instances(cluster_name_3x)
```

**200 응답**

없음

------

# deleteImage
<a name="delete-image"></a>

사용자 지정 AWS ParallelCluster 이미지 삭제를 시작합니다.

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

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

```
DELETE /v3/images/custom/{imageId}
{
  "force": boolean,
  "region": "string"
}
```

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

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

**force**  
`true`로 설정된 경우 AMI를 강제로 삭제합니다. AMI를 사용하는 인스턴스가 있거나 AMI가 공유된 경우이 파라미터를 사용합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

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

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

```
{
  "image": {
    "imageId": "string",
    "ec2AmiInfo": {
      "amiId": "string"
    },
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "imageBuildStatus": "DELETE_IN_PROGRESS",
    "cloudformationStackStatus": "DELETE_IN_PROGRESS"
  }
}
```

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

**image**    
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**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`  
**ec2AmiInfo**    
**amiId**  
Amazon EC2 AMI ID.  
유형: string  
**imageBuildStatus**  
이미지 빌드 상태입니다.  
유형: string  
유효값: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**imageId**  
이미지의 ID입니다.  
유형: string  
**리전**  
이미지가 생성되는 AWS 리전 입니다.  
유형: string  
**version**  
이미지를 빌드하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

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

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

**요청**

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

**200 응답**

```
{
  "image": {
    "image_build_status": "DELETE_IN_PROGRESS",
    "image_id": "custom-image-id",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------

# describeCluster
<a name="describe-cluster"></a>

기존 클러스터에 대한 세부 정보를 가져옵니다.

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

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

```
GET /v3/clusters/{clusterName}
{
  "region": "string"
}
```

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

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**리전**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

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

**참고**  
`failureReason`가 AWS ParallelCluster 버전 3.5.0`failures`부터 로 변경되었습니다.

```
{
  "clusterName": "string",
  "region": "string",
  "version": "string",
  "cloudFormationStackStatus": "CREATE_IN_PROGRESS",
  "clusterStatus": "CREATE_IN_PROGRESS",
  "scheduler": {
    "type": "string",
    "metadata": {
      "name": "string",
      "version": "string"
    }
  },
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastUpdatedTime": "2019-08-24T14:15:22Z",
  "clusterConfiguration": {
    "url": "string"
  },
  "computeFleetStatus": "START_REQUESTED",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "headNode": {
    "instanceId": "string",
    "instanceType": "string",
    "launchTime": "2019-08-24T14:15:22Z",
    "privateIpAddress": "string",
    "publicIpAddress": "string",
    "state": "pending"
  },
  "failures": [
    {
      "failureCode": "string",
      "failureReason": "string"
    }
  ],
  "loginNodes": {      
    "status": "string",
    "address": "string",
    "poolName": "string",
    "scheme": "string",
    "healthyNodes": integer,
    "unhealthyNodes": integer
  }
}
```

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

**clusterName**  
클러스터의 이름입니다.  
유형: string

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

**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`

**clusterConfiguration**    
**url**  
클러스터 구성 파일의 URL입니다.  
유형: string

**clusterStatus**  
클러스터 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`

**computeFleetStatus**  
컴퓨팅 플릿 상태입니다.  
유형: string  
유효값: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**creationTime**  
클러스터가 생성된 시간의 타임스탬프입니다.  
유형: 날짜/시간

**lastUpdatedTime**  
클러스터가 마지막으로 업데이트된 시간의 타임스탬프입니다.  
유형: 날짜/시간

**리전**  
클러스터가 생성되는 AWS 리전 입니다.  
유형: string

**tags**  
클러스터와 연관된 태그의 목록입니다.    
**키**  
태그 이름입니다.  
유형: string  
**tag**  
태그 값입니다.  
유형: string

**version**  
클러스터를 생성하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**failures**  
클러스터 스택이 `CREATE_FAILED` 상태에 있을 때의 실패 목록입니다.    
**failureCode**  
클러스터 스택이 `CREATE_FAILED` 상태에 있을 때의 장애 코드입니다.  
유형: string  
**failureReason**  
클러스터 스택이 `CREATE_FAILED` 상태일 때 오류가 발생하는 이유입니다.  
유형: string

**head\$1node**  
클러스터 헤드 노드입니다.    
**instanceId**  
Amazon EC2 인스턴스 ID입니다.  
유형: string  
**instanceType**  
Amazon EC2 인스턴스 유형  
유형: string  
**launchTime**  
Amazon EC2 인스턴스가 시작된 시간입니다.  
유형: 날짜/시간  
**privateIpAddress**  
클러스터 프라이빗 IP 주소입니다.  
유형: string  
**publicIpAddress**  
클러스터 퍼블릭 IP 주소입니다.  
유형: string  
**state**  
헤드 노드 인스턴스 상태입니다.  
유형: string  
유효값: `pending | running | shutting-down | terminated | stopping | stopped`

**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string

**loginNodes**    
status  
로그인 노드 상태입니다.  
유형: string  
유효값: `PENDING | FAILED | ACTIVE`  
address  
로그인 노드 주소입니다.  
유형: string  
poolName  
로그인 노드 풀 이름입니다.  
유형: string  
scheme  
로그인 노드 스키마입니다.  
유형: string  
healthyNodes  
정상 노드 수입니다.  
유형: 정수  
unhealthyNodes  
비정상 노드의 수입니다.  
유형: 정수

**type**  
스케줄러의 유형입니다.  
유형: string

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

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

**요청**

```
$ describe_cluster(cluster_name_3x)
```

**200 응답**

```
{
  "cloud_formation_stack_status": "CREATE_COMPLETE",
  "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
  "cluster_configuration": {
    "url": "https://parallelcluster-...."
  },
  "cluster_name": "cluster_name_3x",
  "cluster_status": "CREATE_COMPLETE",
  "compute_fleet_status": "RUNNING",
  "creation_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "head_node": {
    "instance_id": "i-abcdef01234567890",
    "instance_type": "t2.micro",
    "launch_time": datetime.datetime(2022, 3, 28, 22, 21, 56, tzinfo=tzlocal()),
    "private_ip_address": "172.31.56.3",
    "public_ip_address": "107.23.100.164",
    "state": "running"
  },
  "last_updated_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "region": "us-east-1",
  "tags": [
    {
      "key": "parallelcluster:version", "value": "3.2.1"
    }
  ],
  "version": "3.2.1"
}
```

------

# describeClusterInstances
<a name="describe-cluster-instances"></a>

클러스터에 속하는 인스턴스를 설명합니다.

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

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

```
GET /v3/clusters/{clusterName}/instances
{
  "nextToken": "string",
  "nodeType": "string",
  "queueName": "string",
  "region": "string"
}
```

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

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**nodeType**  
노드 유형별로 인스턴스를 필터링합니다.  
유형: string  
유효한 값: `HeadNode`, `ComputeNode`, `LoginNode`   
필수 여부: 아니요

**queueName**  
대기열 이름을 기준으로 인스턴스를 필터링합니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

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

```
{
  "nextToken": "string",
  "instances": [
    {
      "instanceId": "string",
      "instanceType": "string",
      "launchTime": "2019-08-24T14:15:22Z",
      "privateIpAddress": "string",
      "publicIpAddress": "string",
      "state": "pending",
      "nodeType": "HeadNode",
      "queueName": "string",
      "poolName": "string"
    }
  ]
}
```

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

**instances**  
클러스터 인스턴스 목록입니다입니다.    
**instanceId**  
Amazon EC2 인스턴스 ID입니다.  
유형: string  
**instanceType**  
Amazon EC2 인스턴스 유형  
유형: string  
**launchTime**  
Amazon EC2 인스턴스가 시작된 시간입니다.  
유형: 날짜/시간  
**nodeType**  
노드 유형입니다.  
유형: string  
유효한 값: `HeadNode`, `ComputeNode`, `LoginNode`   
**publicIpAddress**  
클러스터 퍼블릭 IP 주소입니다.  
유형: string  
**queueName**  
Amazon EC2 인스턴스가 노드를 지원하는 대기열의 이름입니다.  
유형: string  
**state**  
노드 Amazon EC2 인스턴스 상태입니다.  
유형: string  
유효값: `pending | running | shutting-down | terminated | stopping | stopped`

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

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

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

**요청**

```
$ describe_cluster_instances(cluster_name_3x)
```

**200 응답**

```
{
  "instances": [
    {
      "instance_id": "i-abcdef01234567890",
      "instance_type": "t2.micro",
      "launch_time": datetime.datetime(2022, 3, 30, 14, 2, 7, tzinfo=tzlocal()),
      "node_type": "HeadNode",
      "private_ip_address": "192.0.2.5",
      "public_ip_address": "198.51.100.180",
      "state": "running"
    }
  ]
}
```

------

# describeComputeFleet
<a name="describe-compute-fleet"></a>

컴퓨팅 플릿의 상태를 설명합니다.

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

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

```
GET /v3/clusters/{clusterName}/computefleet
{
  "region": "string"
}
```

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

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**리전**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

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

```
{
  "status": "START_REQUESTED",
  "lastStatusUpdatedTime": "2019-08-24T14:15:22Z"
}
```

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

**status**  
유형: string  
유효값: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**lastStatusUpdatedTime**  
마지막 상태 업데이트 시간을 나타내는 타임스탬프입니다.  
유형: 날짜/시간

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

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

**요청**

```
$ describe_compute_fleet(cluster_name_3x)
```

**200 응답**

```
{
  "last_status_updated_time": datetime.datetime(2022, 3, 28, 22, 27, 14, tzinfo=tzlocal()),
  "status": "RUNNING"
}
```

------

# 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"
}
```

------

# getClusterLogEvents
<a name="get-cluster-log-events"></a>

로그 스트림과 연결된 이벤트를 검색합니다.

**Topics**
+ [요청 구문](#get-cluster-log-events-request)
+ [요청 본문](#get-cluster-log-events-request-body)
+ [응답 구문](#get-cluster-log-events-response)
+ [응답 본문](#get-cluster-log-events-response-body)
+ [예제](#get-cluster-log-events-example)

## 요청 구문
<a name="get-cluster-log-events-request"></a>

```
GET /v3/clusters/{clusterName}/logstreams/{logStreamName}
{
  "endTime": datetime,
  "limit": float,
  "nextToken": "string",
  "region": "string",
  "startFromHead": boolean,
  "startTime": datetime
}
```

## 요청 본문
<a name="get-cluster-log-events-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**logStreamName**  
로그 스트림의 이름입니다.  
유형: string  
필수 항목 여부: 예

**endTime**  
시간 범위의 끝입니다. ISO 8601 형식으로 표시됩니다. 타임스탬프가 이 시간 이후인 이벤트는 포함되지 않습니다.  
유형: 날짜/시간  
형식: `2021-01-01T20:00:00Z`  
필수 여부: 아니요

**제한**  
반환된 로그 이벤트의 최대 수입니다. 값을 지정하지 않으면 최대값은 응답 크기 1MB 또는 최대 10,000개의 로그 이벤트에 적합할 수 있는 로그 이벤트 수입니다.  
유형: float  
필수 여부: 아니요

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수 항목 여부: 아니요

**startFromHead**  
`true`로 설정하면 가장 이른 로그 이벤트가 먼저 반환됩니다. 값이 `false`인 경우 최신 로그 이벤트가 먼저 반환됩니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**startTime**  
시간 범위의 시작입니다. ISO 8601 형식으로 표시됩니다. 타임스탬프가 이 시간 이후인 이벤트가 포함됩니다.  
유형: 날짜/시간  
형식: `2021-01-01T20:00:00Z`  
필수 항목 여부: 아니요

## 응답 구문
<a name="get-cluster-log-events-response"></a>

```
{
  "nextToken": "string",
  "prevToken": "string",
  "events": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "message": "string"
    }
  ]
}
```

## 응답 본문
<a name="get-cluster-log-events-response-body"></a>

**events**  
필터링된 이벤트 목록입니다.    
**message**  
이벤트 메시지  
유형: string  
**타임스탬프**  
이벤트 타임스탬프입니다.  
유형: 날짜/시간

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

**prevToken**  
이전 결과 세트를 검색하거나 추가 결과가 없는 `null` 경우 사용할 수 있는 토큰입니다.  
유형: string

## 예제
<a name="get-cluster-log-events-example"></a>

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

**요청**

```
$ get_cluster_log_events(cluster_name_3x, log_stream_name=ip-192-0-2-26.i-abcdef01234567890.cfn-init)
```

**200 응답**

```
"events": [
  {
    "message": "2022-09-22 16:40:15,127 [DEBUG] CloudFormation client initialized with endpoint https://cloudformation.us-east-1.amazonaws.com",
    "timestamp": "2022-09-22T16:40:15.127Z"
  },
  {
    "message": "2022-09-22 16:40:15,127 [DEBUG] Describing resource HeadNodeLaunchTemplate in stack cluster_name_3x",
    "timestamp": "2022-09-22T16:40:15.127Z"
  },
  ...
]
```

------

# getClusterStackEvents
<a name="get-cluster-stack-events"></a>

클러스터의 스택과 관련된 이벤트를 검색합니다.

**참고**  
버전 3.6.0부터는 중첩 스택을 AWS ParallelCluster 사용하여 대기열 및 컴퓨팅 리소스와 연결된 리소스를 생성합니다. `GetClusterStackEvents` API와 `pcluster get-cluster-stack-events` 명령은 클러스터 메인 스택 이벤트만 반환합니다. CloudFormation 콘솔에서 대기열 및 컴퓨팅 리소스와 관련된 이벤트를 비롯한 클러스터 스택 이벤트를 볼 수 있습니다.

**Topics**
+ [요청 구문](#get-cluster-stack-events-request)
+ [요청 본문](#get-cluster-stack-events-request-body)
+ [응답 구문](#get-cluster-stack-events-response)
+ [응답 본문](#get-cluster-stack-events-response-body)
+ [예제](#get-cluster-stack-events-example)

## 요청 구문
<a name="get-cluster-stack-events-request"></a>

```
GET /v3/clusters/{clusterName}/stackevents
{
  "nextToken": "string",
  "region": "string"
}
```

## 요청 본문
<a name="get-cluster-stack-events-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="get-cluster-stack-events-response"></a>

```
{
  "nextToken": "string",
  "events": [
    {
      "stackId": "string",
      "eventId": "string",
      "stackName": "string",
      "logicalResourceId": "string",
      "physicalResourceId": "string",
      "resourceType": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "resourceStatus": "CREATE_IN_PROGRESS",
      "resourceStatusReason": "string",
      "resourceProperties": "string",
      "clientRequestToken": "string"
    }
  ]
}
```

## 응답 본문
<a name="get-cluster-stack-events-response-body"></a>

**events**  
필터링된 이벤트 목록입니다.    
**clientRequestToken**  
이 이벤트를 생성한 액션에 전달된 토큰입니다.  
유형: string  
**eventId**  
이 이벤트의 고유 ID입니다.  
유형: string  
**logicalResourceId**  
템플릿에 지정된 리소스의 논리명입니다.  
유형: string  
**physicalResourceId**  
리소스의 물리적 인스턴스와 연결된 이름 또는 고유 식별자입니다.  
유형: string  
**resourceProperties**  
리소스를 만드는 데 사용되는 속성의 BLOB입니다.  
유형: string  
**resourceStatus**  
리소스 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE`  
**resourceStatusReason**  
리소스와 관련된 성공 또는 실패 메시지입니다.  
유형: string  
**resourceType**  
리소스의 유형입니다.  
유형: string  
**stackId**  
스택 인스턴스의 고유 ID 이름입니다.  
유형: string  
**stackName**  
스택과 연결되어 있는 이름입니다.  
유형: string  
**타임스탬프**  
상태가 업데이트된 시간입니다.  
유형: 날짜/시간

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="get-cluster-stack-events-example"></a>

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

**요청**

```
$ get_cluster_stack_events(cluster_name_3x)
```

**200 응답**

```
{
  "events": [
    {
      "event_id": "590b3820-b081-11ec-985e-0a7af5751497",
      "logical_resource_id": "cluster_name_3x",
      "physical_resource_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/11a59710-b080-11ec-b8bd-129def1380e9",
      "resource_status": "CREATE_COMPLETE",
      "resource_type": "AWS::CloudFormation::Stack",
      "stack_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/11a59710-b080-11ec-b8bd-129def1380e9",
      "stack_name": "cluster_name_3x",
      "timestamp": datetime.datetime(2022, 3, 30, 23, 30, 13, 268000, tzinfo=tzlocal())
    },
    ...
  ]
}
```

------

# getImageLogEvents
<a name="get-image-log-events"></a>

이미지 빌드와 관련된 이벤트를 검색합니다.

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

## 요청 구문
<a name="get-image-log-events-request"></a>

```
GET /v3/images/custom/{imageId}/logstreams/{logStreamName}
{
  "endTime": datetime,
  "limit": float,
  "nextToken": "string",
  "region": "string",
  "startFromHead": boolean,
  "startTime": datetime
}
```

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

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

**logStreamName**  
로그스트림의 이름입니다.  
유형: string  
필수 항목 여부: 예

**endTime**  
시간 범위의 끝입니다. ISO 8601 형식으로 표시됩니다. 타임스탬프가 이 시간 이후인 이벤트는 포함되지 않습니다.  
유형: 날짜/시간  
형식: `2021-01-01T20:00:00Z`  
필수 여부: 아니요

**제한**  
반환된 로그 이벤트의 최대 수입니다. 값을 지정하지 않는 경우 최대값은 1MB의 응답 크기에 들어갈 수 있는 로그 이벤트 수(최대 10,000개의 로그 이벤트)입니다.  
유형: float  
필수 여부: 아니요

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
이미지가 AWS 리전 있는 입니다.  
유형: string  
필수 항목 여부: 아니요

**startFromHead**  
`true`로 설정된 경우 가장 이른 로그 이벤트를 먼저 반환합니다. false로 설정되어 있는 경우에는 최신 로그 이벤트를 먼저 반환합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**startTime**  
시간 범위의 시작입니다. ISO 8601 형식으로 표시됩니다. 타임스탬프가 이 시간 이후인 이벤트가 포함됩니다.  
유형: 날짜/시간  
형식: `2021-01-01T20:00:00Z`  
필수 항목 여부: 아니요

## 응답 구문
<a name="get-image-log-events-response"></a>

```
{
  "nextToken": "string",
  "prevToken": "string",
  "events": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "message": "string"
    }
  ]
}
```

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

**events**  
필터링된 이벤트 목록입니다.    
**message**  
이벤트 메시지  
유형: string  
**타임스탬프**  
이벤트 타임스탬프입니다.  
유형: 날짜/시간

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

**prevToken**  
이전 결과 세트를 검색하거나 추가 결과가 없는 `null` 경우 사용할 수 있는 토큰입니다.  
유형: string

## 예제
<a name="get-image-log-events-example"></a>

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

**요청**

```
$ get_image_log_events(image_id, log_stream_name=3.2.1/1)
```

**200 응답**

```
"events": [
  {
    "message": "ExecuteBash: STARTED EXECUTION",
    "timestamp": 2022-04-05T15:51:20.228Z"
  },
  {
    "message": "ExecuteBash: Created temporary directory: /tmp/1234567890abcdef0",
    "timestamp": "2022-04-05T15:51:20.228Z"
  },
  ...
]
```

------

# getImageStackEvents
<a name="get-image-stack-events"></a>

이미지 빌드의 스택과 관련된 이벤트를 검색합니다.

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

## 요청 구문
<a name="get-image-stack-events-request"></a>

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

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

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

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
이미지가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="get-image-stack-events-response"></a>

```
{
  "nextToken": "string",
  "events": [
    {
      "stackId": "string",
      "eventId": "string",
      "stackName": "string",
      "logicalResourceId": "string",
      "physicalResourceId": "string",
      "resourceType": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "resourceStatus": "CREATE_IN_PROGRESS",
      "resourceStatusReason": "string",
      "resourceProperties": "string",
      "clientRequestToken": "string"
    }
  ]
}
```

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

**events**  
필터링된 이벤트 목록입니다.    
**clientRequestToken**  
이 이벤트를 생성한 액션에 전달된 토큰입니다.  
유형: string  
**eventId**  
이 이벤트의 고유 ID입니다.  
유형: string  
**logicalResourceId**  
템플릿에 지정된 리소스의 논리명입니다.  
유형: string  
**physicalResourceId**  
리소스의 물리적 인스턴스와 연결된 이름 또는 고유 식별자입니다.  
유형: string  
**resourceProperties**  
리소스를 만드는 데 사용되는 속성의 BLOB입니다.  
유형: string  
**resourceStatus**  
리소스 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE`  
**resourceStatusReason**  
리소스와 관련된 성공 또는 실패 메시지입니다.  
유형: string  
**resourceType**  
리소스의 유형입니다.  
유형: string  
**stackId**  
스택 인스턴스의 고유 ID 이름입니다.  
유형: string  
**stackName**  
스택과 연결되어 있는 이름입니다.  
유형: string  
**타임스탬프**  
상태가 업데이트된 시간입니다.  
유형: 날짜/시간

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="get-image-stack-events-example"></a>

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

**요청**

```
$ get_image_stack_events(image_id)
```

**200 응답**

```
{
  'events': [
    {
      'event_id': 'ParallelClusterImage-CREATE_IN_PROGRESS-2022-03-30T23:26:33.499Z',
      'logical_resource_id': 'ParallelClusterImage',
      'physical_resource_id': 'arn:aws:imagebuilder:us-east-1:123456789012:image/parallelclusterimage-alinux2-image/3.2.1/1',
      'resource_properties': {
        "InfrastructureConfigurationArn":"arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/parallelclusterimage-6accc570-b080-11ec-845e-0e2dc6386985",
        "ImageRecipeArn":"arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/parallelclusterimage-alinux2-image/3.2.1",
        "DistributionConfigurationArn":"arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/parallelclusterimage-6accc570-b080-11ec-845e-0e2dc6386985",
        "EnhancedImageMetadataEnabled":"false",
        "Tags": {
          "parallelcluster:image_name":"alinux2-image","parallelcluster:image_id":"alinux2-image"
        }
      },
      'resource_status': 'CREATE_IN_PROGRESS',
      'resource_status_reason': 'Resource creation Initiated',
      'resource_type': 'AWS::ImageBuilder::Image',
      'stack_id': 'arn:aws:cloudformation:us-east-1:123456789012:stack/alinux2-image/6accc570-b080-11ec-845e-0e2dc6386985',
      'stack_name': 'alinux2-image',
      'timestamp': datetime.datetime(2022, 3, 30, 23, 26, 33, 499000, tzinfo=tzlocal())
    },
    ...
  ]
}
```

------

# listClusters
<a name="list-clusters"></a>

기존 클러스터의 목록을 검색합니다.

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

## 요청 구문
<a name="list-clusters-request"></a>

```
GET /v3/clusters
{
  "clusterStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

## 요청 본문
<a name="list-clusters-request-body"></a>

**clusterStatus**  
클러스터 상태별로 필터링합니다. 기본값은 모든 클러스터입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
필수 항목 여부: 아니요

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
클러스터 AWS 리전 의 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="list-clusters-response"></a>

```
{
  "nextToken": "string",
  "clusters": [
    {
      "clusterName": "string",
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS",
      "clusterStatus": "CREATE_IN_PROGRESS",
      "scheduler": {
        "type": "string",
        "metadata": {
          "name": "string",
          "version": "string"
        }
      }
    }
  ]
}
```

## 응답 본문
<a name="list-clusters-response-body"></a>

**클러스터**    
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**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`  
**clusterName**  
클러스터의 이름입니다.  
유형: string  
**clusterStatus**  
클러스터 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string  
**type**  
스케줄러의 유형입니다.  
유형: string  
**리전**  
클러스터가 생성되는 AWS 리전 입니다.  
유형: string  
**version**  
클러스터를 생성하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="list-clusters-example"></a>

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

**요청**

```
$ list_clusters()
```

**200 응답**

```
{
  'clusters': 
   [
      {
        'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241',
        'cloudformation_stack_status': 'CREATE_COMPLETE',
        'cluster_name': 'cluster_name_3x',
        'cluster_status': 'CREATE_COMPLETE',
        'region': 'us-east-1',
        'version': '3.2.1'
      },
      ...
   ]
}
```

------

# listClusterLogStreams
<a name="list-cluster-log-streams"></a>

클러스터와 연결된 로그 스트림의 목록을 검색합니다.

**Topics**
+ [요청 구문](#list-cluster-log-streams-request)
+ [요청 본문](#list-cluster-log-streams-request-body)
+ [응답 구문](#list-cluster-log-streams-response)
+ [응답 본문](#list-cluster-log-streams-response-body)
+ [예제](#list-cluster-log-streams-example)

## 요청 구문
<a name="list-cluster-log-streams-request"></a>

```
GET /v3/clusters/{clusterName}/logstreams
{
  "filters": [ "string" ],
  "nextToken": "string",
  "region": "string"
}
```

## 요청 본문
<a name="list-cluster-log-streams-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**filters**  
로그 스트림을 필터링합니다.  
허용되는 필터는 다음과 같습니다.  
+ private-dns-name: 인스턴스의 프라이빗 DNS 이름의 약식(예: ip-10-0-0-101).
+ node-type: 유효한 값: `HeadNode`
유형: 고유 문자열 배열  
형식: `Name=a,Values=1 Name=b,Values=2,3`  
필수 여부: 아니요

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="list-cluster-log-streams-response"></a>

```
{
  "nextToken": "string",
  "logStreams": [
    {
      "logStreamName": "string",
      "creationTime": "2019-08-24T14:15:22Z",
      "firstEventTimestamp": "2019-08-24T14:15:22Z",
      "lastEventTimestamp": "2019-08-24T14:15:22Z",
      "lastIngestionTime": "2019-08-24T14:15:22Z",
      "uploadSequenceToken": "string",
      "logStreamArn": "string"
    }
  ]
}
```

## 응답 본문
<a name="list-cluster-log-streams-response-body"></a>

**logStreams**  
로그 스트림 목록입니다.    
**creationTime**  
스트림이 생성된 시간입니다.  
유형: 날짜/시간  
**firstEventTimestamp**  
스트림 첫 번째 이벤트의 시간입니다.  
유형: 날짜/시간  
**lastEventTimestamp**  
스트림 마지막 이벤트의 시간입니다. lastEventTime 값은 최종 일관성을 기준으로 업데이트됩니다. 일반적으로 수집 후 한 시간 이내에 업데이트되지만 드물게 그보다 더 오래 걸릴 수 있습니다.  
유형: 날짜/시간  
**lastIngestionTime**  
마지막 수집 시간입니다.  
유형: 날짜/시간  
**logStreamARN**  
로그 스트림의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**logStreamName**  
로그 스트림의 이름입니다.  
유형: string  
**uploadSequenceToken**  
시퀀스 토큰입니다.  
유형: string

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="list-cluster-log-streams-example"></a>

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

**요청**

```
$ list_cluster_log_streams(cluster_name_3x)
```

**200 응답**

```
{
  'log_streams': [
      {
        'creation_time': datetime.datetime(2022, 3, 30, 14, 7, 34, 354000, tzinfo=tzlocal()),
        'first_event_timestamp': datetime.datetime(2022, 3, 30, 14, 6, 41, 444000, tzinfo=tzlocal()),
        'last_event_timestamp': datetime.datetime(2022, 3, 30, 14, 25, 55, 462000, tzinfo=tzlocal()),
        'last_ingestion_time': datetime.datetime(2022, 3, 30, 14, 49, 50, 62000, tzinfo=tzlocal()),
        'log_stream_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/parallelcluster/cluster_name_3x:log-stream:ip-192-0-2-26.i-abcdef01234567890.cfn-init',
        'log_stream_name': 'ip-192-0-2-26.i-abcdef01234567890.cfn-init',
         ...
        'upload_sequence_token': '####'
      },
      ...
   ]
}
```

------

# listImageLogStreams
<a name="list-image-log-streams"></a>

이미지와 관련된 로그 스트림 목록을 검색합니다.

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

## 요청 구문
<a name="list-image-log-streams-request"></a>

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

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

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

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
이미지가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="list-image-log-streams-response"></a>

```
{
  "nextToken": "string",
  "logStreams": [
    {
      "logStreamName": "string",
      "creationTime": "2019-08-24T14:15:22Z",
      "firstEventTimestamp": "2019-08-24T14:15:22Z",
      "lastEventTimestamp": "2019-08-24T14:15:22Z",
      "lastIngestionTime": "2019-08-24T14:15:22Z",
      "uploadSequenceToken": "string",
      "logStreamArn": "string"
    }
  ]
}
```

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

**logStreams**  
로그 스트림 목록입니다.    
**creationTime**  
스트림이 생성된 시간입니다.  
유형: 날짜/시간  
**firstEventTimestamp**  
스트림 내 첫 번째 이벤트의 시간입니다.  
유형: 날짜/시간  
**lastEventTimestamp**  
스트림 마지막 이벤트의 시간입니다. lastEventTime 값은 최종 일관성을 기준으로 업데이트됩니다. 일반적으로 수집 후 한 시간 이내에 업데이트되지만 드물게 그보다 더 오래 걸릴 수 있습니다.  
유형: 날짜/시간  
**lastIngestionTime**  
마지막 수집 시간입니다.  
유형: 날짜/시간  
**logStreamARN**  
로그 스트림의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**logStreamName**  
로그 스트림의 이름입니다.  
유형: string  
**uploadSequenceToken**  
시퀀스 토큰입니다.  
유형: string

**next\$1token**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="list-image-log-streams-example"></a>

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

**요청**

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

**200 응답**

```
{
  'log_streams': [
    {
      'creation_time': datetime.datetime(2022, 3, 29, 20, 29, 24, 875000, tzinfo=tzlocal()),
      'first_event_timestamp': datetime.datetime(2022, 3, 29, 20, 29, 24, 775000, tzinfo=tzlocal()),
      'last_event_timestamp': datetime.datetime(2022, 3, 29, 20, 38, 23, 944000, tzinfo=tzlocal()),
      'last_ingestion_time': datetime.datetime(2022, 3, 29, 20, 51, 56, 26000, tzinfo=tzlocal()),
      'log_stream_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image:log-stream:3.2.1/1',
      'log_stream_name': '3.2.1/1',
      'upload_sequence_token': '####'
    },
    ...
  ]
}
```

------

# listImages
<a name="list-images"></a>

기존 사용자 지정 이미지 목록을 검색합니다.

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

## 요청 구문
<a name="list-images-request"></a>

```
GET /images/custom
{
  "imageStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

## 요청 본문
<a name="list-images-request-body"></a>

**imageStatus**  
제공된 상태별로 이미지를 필터링합니다.  
유형: string  
유효값: `AVAILABLE | PENDING | FAILED`  
필수 항목 여부: 예

**nextToken**  
다음 결과 집합에 대한 토큰입니다.  
유형: string  
필수 항목 여부: 아니요

**region**  
해당 이미지가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="list-images-response"></a>

```
{
  "nextToken": "string",
  "images": [
    {
      "imageId": "string",
      "ec2AmiInfo": {
        "amiId": "string"
      },
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "imageBuildStatus": "BUILD_IN_PROGRESS",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS"
    }
  ]
}
```

## 응답 본문
<a name="list-images-response-body"></a>

**images**  
이미지의 목록입니다.    
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**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`  
**ec2AmiInfo**    
**ami\$1id**  
Amazon EC2 AMI ID.  
유형: string  
**imageBuildStatus**  
이미지 빌드 상태입니다.  
유효값: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
유형: string  
**imageId**  
이미지의 ID입니다.  
유형: string  
**리전**  
이미지가 생성되는 AWS 리전 입니다.  
유형: string  
**version**  
이미지를 빌드하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**nextToken**  
다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 `null`입니다.  
유형: string

## 예제
<a name="list-images-example"></a>

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

**요청**

```
$ list_images("AVAILABLE")
```

**200 응답**

```
{
  'images': [
    {
      'ec2_ami_info': {
        'ami_id': 'ami-abcdef01234567890'
      },
      'image_build_status': 'BUILD_COMPLETE',
      'image_id': 'custom-image',
      'region': 'us-east-1',
      'version': '3.2.1'
    }
  ]
}
```

------

# listOfficialImages
<a name="list-official-images"></a>

 AWS ParallelCluster 공식 이미지 목록을 검색합니다.

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

## 요청 구문
<a name="list-official-images-request"></a>

```
GET /v3/images/official
{  
  "architecture": "string",
  "os": "string",
  "region": "string"
}
```

## 요청 본문
<a name="list-official-images-request-body"></a>

**architecture**  
아키텍처별로 필터링합니다. 기본값은 필터링 없음입니다.  
유형: string  
유효값: `x86_64 | arm64`  
필수 여부: 아니요

**os**  
OS 배포를 기준으로 필터링합니다. 기본값은 필터링 없음입니다.  
유형: string  
유효값: `alinux2 | alinux2023 | ubuntu2404 | ubuntu2204 | rhel8 | rhel9`  
필수 여부: 아니요

**region**  
공식 이미지가 나열 AWS 리전 되는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="list-official-images-response"></a>

```
{
  "images": [
    {
      "architecture": "string",
      "amiId": "string",
      "name": "string",
      "os": "string",
      "version": "string"
    }
  ]
}
```

## 응답 본문
<a name="list-official-images-response-body"></a>

**images**    
**amiId**  
AMI의 ID입니다.  
유형: string  
**architecture**  
AMI 아키텍처입니다.  
유형: string  
**name**  
AMI의 이름입니다.  
유형: string  
**os**  
AMI 운영 체제입니다.  
유형: string  
**version**  
 AWS ParallelCluster 버전입니다.  
유형: string

## 예제
<a name="list-official-images-example"></a>

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

**요청**

```
$ list_official_images()
```

**200 응답**

```
{
  'images': [ 
    {
      'ami_id': 'ami-015cfeb4e0d6306b2',
      'architecture': 'x86_64',
      'name': 'aws-parallelcluster-3.2.1-ubuntu-2204-lts-hvm-x86_64-202202261505 '
      '2022-02-26T15-08-34.759Z',
      'os': 'ubuntu2204',
      'version': '3.2.1'
    },
    ...
  ]
}
```

------

# updateCluster
<a name="update-cluster"></a>

클러스터를 업데이트합니다.

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

## 요청 구문
<a name="update-cluster-request"></a>

```
PUT /v3/clusters/{clusterName}
{
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "forceUpdate": boolean,
  "region": "string",
  "suppressValidators": "string",
  "validationFailureLevel": "string"
}
```

## 요청 본문
<a name="update-cluster-request-body"></a>

**clusterConfiguration**  
YAML 문서로서의 클러스터 구성입니다.  
필수 여부: 예

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**dryrun**  
`true`로 설정하면 리소스를 만들지 않고 요청 검증만 수행합니다. 이 파라미터를 사용하여 클러스터 구성과 업그레이드 요구 사항을 확인합니다. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**forceUpdate**  
`true`로 설정된 경우 업데이트 검증 오류를 무시하고 강제로 업데이트하세요. 기본값은 `false`입니다.  
유형: boolean  
필수 항목 여부: 아니요

**region**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수 항목 여부: 아니요

**suppressValidators**  
억제할 구성 유효성 검사기를 하나 이상 식별하세요.  
유형: string  
형식: `(ALL|type:[A-Za-z0-9]+)`  
필수 여부: 아니요  
유효한 값의 예제: `currentValue`, `requestedValue`, `message` 

**validationFailureLevel**  
업데이트 실패의 원인이 되는 최소 검증 수준입니다.  
유형: string  
유효값: `INFO | WARNING | ERROR`  
필수 항목 여부: 아니요

## 응답 구문
<a name="update-cluster-response"></a>

```
{
  "cluster": {
    "clusterName": "string",
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "cloudformationStackStatus": "UPDATE_IN_PROGRESS",
    "clusterStatus": "UPDATE_IN_PROGRESS",
    "scheduler": {
      "type": "string",
      "metadata": {
        "name": "string",
        "version": "string"
      }
    }
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ],
  "changeSet": [
    {
      "parameter": "string",
      "currentValue": "string",
      "requestedValue": "string"
    }
  ]
}
```

## 응답 본문
<a name="update-cluster-response-body"></a>

**changeSet**  
클러스터 업데이트의 변경 세트입니다.    
**currentValue**  
업데이트할 파라미터의 현재 값입니다.  
유형: string  
**parameter**  
업데이트할 파라미터입니다.  
유형: string  
**requestedValue**  
업데이트할 파라미터에 요청된 값입니다.  
유형: string

**cluster**    
**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string  
**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`  
**clusterName**  
클러스터의 이름입니다.  
유형: string  
**clusterStatus**  
클러스터 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**리전**  
클러스터가 생성되는 AWS 리전 입니다.  
유형: string  
**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string  
**type**  
스케줄러의 유형입니다.  
유형: string

**version**  
AWS ParallelCluster 클러스터를 생성하는 데 사용되는 버전입니다.  
유형: string

**validationMessages**  
검증 수준이 `validationFailureLevel`보다 낮은 메시지 목록입니다. 메시지 목록은 구성 검증 중에 수집됩니다.    
**id**  
검사기의 ID입니다.  
유형: string  
**level**  
검증 수준입니다.  
유형: string  
유효값: `INFO | WARNING | ERROR`  
**message**  
확인 메시지입니다.  
유형: string  
**type**  
검사기의 유형입니다.  
유형: string

## 예제
<a name="update-cluster-example"></a>

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

**요청**

```
$ update_cluster(cluster_name_3x, path/config-file.yaml)
```

**200 응답**

```
{
  'change_set': [
    {
      'current_value': '10',
      'parameter': 'Scheduling.SlurmQueues[queue1].ComputeResources[t2micro].MaxCount',
      'requested_value': '15'
    }
  ],
  'cluster': {
    'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/test-api-cluster/e0462730-50b5-11ed-99a3-0a5ddc4a34c7',
    'cloudformation_stack_status': 'UPDATE_IN_PROGRESS',
    'cluster_name': 'cluster-3x',
    'cluster_status': 'UPDATE_IN_PROGRESS',
    'region': 'us-east-1',
    'scheduler': {
      'type': 'slurm'
    },
    'version': '3.2.1'
  }
}
```

------

# 컴퓨팅 플릿 업데이트
<a name="update-compute-fleet"></a>

클러스터 컴퓨팅 플릿의 상태를 업데이트합니다.

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

## 요청 구문
<a name="update-compute-fleet-request"></a>

```
PATCH /v3/clusters/{clusterName}/computefleet
{
  "status": "string",
  "region": "string"
}
```

## 요청 본문
<a name="update-compute-fleet-request-body"></a>

**clusterName**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**status**  
컴퓨팅 플릿 상태입니다.  
유형: string  
유효값: `START_REQUESTED | STOP_REQUESTED | ENABLED | DISABLED`  
필수 사항 여부: 예

**리전**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<a name="update-compute-fleet-response"></a>

```
{
  "status": "START_REQUESTED",
  "lastStatusUpdatedTime": "2019-08-24T14:15:22Z"
}
```

## 응답 본문
<a name="update-compute-fleet-response-body"></a>

**status**  
컴퓨팅 플릿 상태입니다.  
유형: string  
유효값: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**lastStatusUpdatedTime**  
마지막 상태 업데이트 시간을 나타내는 타임스탬프입니다.  
유형: 날짜/시간

## 예제
<a name="update-compute-fleet-example"></a>

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

**요청**

```
$ update_compute_fleet(cluster_name_3x,  "START_REQUESTED")
```

**200 응답**

```
{
  'last_status_updated_time': datetime.datetime(2022, 3, 28, 22, 27, 14, tzinfo=tzlocal()),
  'status': 'START_REQUESTED'
}
```

------