describe_pod_identity_association ¶

describe_pod_identity_association(
    cluster_name: String,
    association_id: String,
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> DescribePodIdentityAssociationResponse

Returns descriptive information about an EKS Pod Identity association.

This action requires the ID of the association. You can get the ID from the response to the CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for associations with ListPodIdentityAssociations and filter the list by namespace or service account.

Parameters:

cluster_name (String) –

The name of the cluster that the association is in.
association_id (String) –

The ID of the association that you want the description of.

Raises:

InvalidParameterException –

The specified parameter is invalid. Review the available parameters for the API request.
InvalidRequestException –

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
ResourceNotFoundException –

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.
ServerException –

These errors are usually caused by a server-side issue.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_eks/_services/eks.py

def describe_pod_identity_association(
    self,
    cluster_name: "capo_eks.types.string.String",
    association_id: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> "capo_eks.types.describe_pod_identity_association_response.DescribePodIdentityAssociationResponse":
    """<p>Returns descriptive information about an EKS Pod Identity association.</p> <p>This action requires the ID of the association. You can get the ID from the response to the <code>CreatePodIdentityAssocation</code> for newly created associations. Or, you can list the IDs for associations with <code>ListPodIdentityAssociations</code> and filter the list by namespace or service account.</p>

    Args:
        cluster_name: <p>The name of the cluster that the association is in.</p>
        association_id: <p>The ID of the association that you want the description of.</p>

    Raises:
        capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_eks.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.</p>
        capo_eks.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. You can view your available clusters with <code>ListClusters</code>. You can view your available managed node groups with <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region specific.</p>
        capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.describe_pod_identity_association_request.DescribePodIdentityAssociationRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_pod_identity_association_response.DescribePodIdentityAssociationResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_pod_identity_association

        output, http_response = (
            capo_eks._operations.aws_wesley_frontend.describe_pod_identity_association.describe_pod_identity_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePodIdentityAssociation")
    )
    input_: capo_eks.types.describe_pod_identity_association_request.DescribePodIdentityAssociationRequest = {
        "cluster_name": cluster_name,
        "association_id": association_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output