DELETECONTAINERGROUPDEFN()`¶

About DeleteContainerGroupDefinition¶

This API works with the following fleet types: Container

Request options:

Deletes a container group definition.

Delete an entire container group definition, including all versions. Specify the container group definition name, or use an ARN value without the version number.
Delete a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.
Keep the newest versions and delete all older versions. Specify the container group definition name and the number of versions to retain. For example, set VersionCountToRetain to 5 to delete all but the five most recent versions.

Result

If successful, Amazon GameLift Servers removes the container group definition versions that you request deletion for. This request will fail for any requested versions if the following is true:

If the version is being used in an active fleet
If the version is being deployed to a fleet in a deployment that's currently in progress.
If the version is designated as a rollback definition in a fleet deployment that's currently in progress.

Learn more

Manage a container group definition

Method Signature¶

METHODS /AWS1/IF_GML~DELETECONTAINERGROUPDEFN
  IMPORTING
    !IV_NAME TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 OPTIONAL
    !IV_VERSIONNUMBER TYPE /AWS1/GMLPOSITIVEINTEGER OPTIONAL
    !IV_VERSIONCOUNTTORETAIN TYPE /AWS1/GMLWHOLENUMBER OPTIONAL
  PREFERRED PARAMETER iv_name
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldelcontainergrde01
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLTAGGINGFAILEDEX
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00` `/AWS1/GMLCONTAINERGRDEFNAMEO00`¶

The unique identifier for the container group definition to delete. You can use either the Name or ARN value.

Optional arguments:¶

`iv_versionnumber` `TYPE /AWS1/GMLPOSITIVEINTEGER` `/AWS1/GMLPOSITIVEINTEGER`¶

The specific version to delete.

`iv_versioncounttoretain` `TYPE /AWS1/GMLWHOLENUMBER` `/AWS1/GMLWHOLENUMBER`¶

The number of most recent versions to keep while deleting all older versions.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldelcontainergrde01` `/AWS1/CL_GMLDELCONTAINERGRDE01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->deletecontainergroupdefn(
  iv_name = |string|
  iv_versioncounttoretain = 123
  iv_versionnumber = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_GML=>DELETECONTAINERGROUPDEFN()¶