

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# Descrivi l'immagine
<a name="describe-image"></a>

Ottieni informazioni dettagliate su un'immagine esistente.

**Topics**
+ [Sintassi della richiesta](#describe-image-request)
+ [Corpo di richiesta](#describe-image-request-body)
+ [Sintassi della risposta](#describe-image-response)
+ [Corpo di risposta](#describe-image-response-body)
+ [Esempio](#describe-image-example)

## Sintassi della richiesta
<a name="describe-image-request"></a>

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

## Corpo di richiesta
<a name="describe-image-request-body"></a>

**imageId**  
L'ID dell'immagine.  
Tipo: stringa  
Campo obbligatorio: sì

**Regione**  
L' Regione AWS elemento in cui è stata creata l'immagine.  
Tipo: stringa  
Campo obbligatorio: no

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

## Corpo di risposta
<a name="describe-image-response-body"></a>

**imageId**  
L'ID dell'immagine per cui recuperare informazioni dettagliate.  
Tipo: stringa

**imageBuildStatus**  
Lo stato di creazione dell'immagine.  
Tipo: stringa  
Valori validi: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`

**Configurazione dell'immagine**    
**url**  
L'URL del file di configurazione dell'immagine.  
Tipo: stringa

**Regione**  
Il Regione AWS file in cui viene creata l'immagine.  
Tipo: stringa

**version**  
La AWS ParallelCluster versione utilizzata per creare l'immagine.  
Tipo: stringa

**cloudformationStackArn**  
L'Amazon Resource Name (ARN) dello stack principale CloudFormation .  
Tipo: stringa

**cloudformationStackCreationOra**  
L'ora in cui è stato creato CloudFormation lo stack.  
Tipo: datetime

**cloudformationStackStatus**  
Lo CloudFormation stato dello stack.  
Tipo: stringa  
Valori validi: `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`

**cloudformationStackStatusMotivo**  
Il motivo dello stato dello CloudFormation stack.  
Tipo: stringa

**cloudformationStackTags**  
L'elenco dei tag per lo CloudFormation stack.    
**Chiave**  
Il nome del tag.  
Tipo: stringa  
**value**  
Il valore del tag.  
Tipo: stringa

**creationTime**  
Gli orari in cui l'immagine è stata creata.  
Tipo: datetime

**ec2 AmiInfo**    
**ID AM**  
L'ID Amazon EC2 AMI.  
Tipo: stringa  
**Un nome**  
Il nome Amazon EC2 AMI.  
Tipo: stringa  
**architecture**  
L'architettura Amazon EC2 AMI.  
Tipo: stringa  
**stato**  
Lo stato dell' EC2 AMI Amazon.  
Tipo: stringa  
Valori validi: `PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`  
**tags**  
Elenco di tag Amazon EC2 AMI.    
**Chiave**  
Nome del tag.  
Tipo: stringa  
**value**  
Valore del tag.  
Tipo: stringa

**imagebuilderImageStatus**  
Lo stato ImageBuilder dell'immagine.  
Tipo: stringa  
Valori validi: `PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`

**imagebuilderImageStatusMotivo**  
Il motivo per cui l' ImageBuilder immagine ha questo status.  
Tipo: stringa

**imageBuildLogsArn**  
L'Amazon Resource Name (ARN) dei log per il processo di creazione dell'immagine.  
Tipo: stringa

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

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

**Richiesta**

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

**200 Risposta**

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

------