EKS / Client / delete_fargate_profile

delete_fargate_profile

EKS.Client.delete_fargate_profile(**kwargs)

Deletes an Fargate profile.

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.

Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.

See also: AWS API Documentation

Request Syntax

response = client.delete_fargate_profile(
    clusterName='string',
    fargateProfileName='string'
)

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the Amazon EKS cluster associated with the Fargate profile to delete.

• fargateProfileName (string) –

  [REQUIRED]

  The name of the Fargate profile to delete.

Return type:

dict

Returns:

Response Syntax

{
    'fargateProfile': {
        'fargateProfileName': 'string',
        'fargateProfileArn': 'string',
        'clusterName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'podExecutionRoleArn': 'string',
        'subnets': [
            'string',
        ],
        'selectors': [
            {
                'namespace': 'string',
                'labels': {
                    'string': 'string'
                }
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • fargateProfile (dict) –

    The deleted Fargate profile.

    • fargateProfileName (string) –

      The name of the Fargate profile.

    • fargateProfileArn (string) –

      The full Amazon Resource Name (ARN) of the Fargate profile.

    • clusterName (string) –

      The name of the Amazon EKS cluster that the Fargate profile belongs to.

    • createdAt (datetime) –

      The Unix epoch timestamp in seconds for when the Fargate profile was created.

    • podExecutionRoleArn (string) –

      The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.

    • subnets (list) –

      The IDs of subnets to launch pods into.

      • (string) –

    • selectors (list) –

      The selectors to match for pods to use this Fargate profile.

      • (dict) –

        An object representing an Fargate profile selector.

        • namespace (string) –

          The Kubernetes namespace that the selector should match.

        • labels (dict) –

          The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.

          • (string) –

            • (string) –

    • status (string) –

      The current status of the Fargate profile.

    • tags (dict) –

      The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

      • (string) –

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • (string) –

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Exceptions

• EKS.Client.exceptions.InvalidParameterException

• EKS.Client.exceptions.ClientException

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ResourceNotFoundException