Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# Beschreiben Sie das Bild
<a name="describe-image"></a>

Holen Sie sich detaillierte Informationen zu einem vorhandenen Bild.

**Topics**
+ [Erforderliche Syntax](#describe-image-request)
+ [Anforderungstext](#describe-image-request-body)
+ [Antwortsyntax](#describe-image-response)
+ [Antworttext](#describe-image-response-body)
+ [Beispiel](#describe-image-example)

## Erforderliche Syntax
<a name="describe-image-request"></a>

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

## Anforderungstext
<a name="describe-image-request-body"></a>

**imageId**  
Die ID des Bildes.  
Type: Zeichenkette  
Erforderlich: Ja

**Region**  
Die, AWS-Region in der das Bild erstellt wurde.  
Type: Zeichenkette  
Erforderlich: Nein

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

## Antworttext
<a name="describe-image-response-body"></a>

**imageId**  
Die ID des Bildes, für das detaillierte Informationen abgerufen werden sollen.  
Type: Zeichenkette

**imageBuildStatus**  
Der Status der Image-Erstellung.  
Type: Zeichenkette  
Zulässige Werte: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`

**Image-Konfiguration**    
**URL**  
Die URL der Image-Konfigurationsdatei.  
Type: Zeichenkette

**Region**  
Die, AWS-Region in der das Bild erstellt wird.  
Type: Zeichenkette

**version**  
Die AWS ParallelCluster Version, mit der das Image erstellt wurde.  
Type: Zeichenkette

**cloudformationStackArn**  
Der Amazon-Ressourcenname (ARN) des CloudFormation Hauptstapels.  
Type: Zeichenkette

**cloudformationStackCreationZeit**  
Die Zeit, zu der der CloudFormation Stapel erstellt wurde.  
Typ: DateTime

**cloudformationStackStatus**  
Der CloudFormation Stack-Status.  
Type: Zeichenkette  
Zulässige Werte: `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`

**cloudformationStackStatusGrund**  
Der Grund für den CloudFormation Stack-Status.  
Type: Zeichenkette

**cloudformationStackTags**  
Die Liste der Tags für den CloudFormation Stack.    
**Schlüssel**  
Der Tag-Name.  
Type: Zeichenkette  
**Wert**  
Der Tag-Wert.  
Type: Zeichenkette

**creationTime**  
Die Zeiten, zu denen das Bild erstellt wurde.  
Typ: DateTime

**ec2 AmiInfo**    
**Ich bin ID**  
Die Amazon EC2 AMI-ID.  
Type: Zeichenkette  
**AMI-Name**  
Der EC2 Amazon-AMI-Name.  
Type: Zeichenkette  
**Anwendung ansehen**  
Die Amazon EC2 AMI-Architektur.  
Type: Zeichenkette  
**state**  
Der Status des Amazon EC2 AMI.  
Type: Zeichenkette  
Zulässige Werte: `PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`  
**tags**  
Liste der Amazon EC2 AMI-Tags.    
**Schlüssel**  
Tag-Name.  
Type: Zeichenkette  
**Wert**  
Tag-Wert.  
Type: Zeichenkette

**imagebuilderImageStatus**  
Der Status des ImageBuilder Bildes.  
Type: Zeichenkette  
Zulässige Werte: `PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`

**imagebuilderImageStatusGrund**  
Der Grund, warum das ImageBuilder Bild diesen Status hat.  
Type: Zeichenkette

**imageBuildLogsArn**  
Der Amazon-Ressourcenname (ARN) der Protokolle für den Image-Erstellungsprozess.  
Type: Zeichenkette

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

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

**Anforderung**

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

**200 Antwort**

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

------