libZSservicesZSamazonka-batchZSamazonka-batch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Batch.DescribeComputeEnvironments

Description

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeComputeEnvironments Source #

Contains the parameters for DescribeComputeEnvironments.

See: newDescribeComputeEnvironments smart constructor.

Constructors

DescribeComputeEnvironments' 

Fields

  • computeEnvironments :: Maybe [Text]

    A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

  • maxResults :: Maybe Int

    The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Instances

Instances details
Eq DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Read DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Show DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Generic DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Associated Types

type Rep DescribeComputeEnvironments :: Type -> Type #

NFData DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Hashable DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToJSON DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

AWSPager DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

AWSRequest DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToHeaders DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToPath DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

ToQuery DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironments = D1 ('MetaData "DescribeComputeEnvironments" "Amazonka.Batch.DescribeComputeEnvironments" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "DescribeComputeEnvironments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeComputeEnvironments Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

newDescribeComputeEnvironments :: DescribeComputeEnvironments Source #

Create a value of DescribeComputeEnvironments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeEnvironments:DescribeComputeEnvironments', describeComputeEnvironments_computeEnvironments - A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

$sel:nextToken:DescribeComputeEnvironments', describeComputeEnvironments_nextToken - The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

$sel:maxResults:DescribeComputeEnvironments', describeComputeEnvironments_maxResults - The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Request Lenses

describeComputeEnvironments_computeEnvironments :: Lens' DescribeComputeEnvironments (Maybe [Text]) Source #

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

describeComputeEnvironments_nextToken :: Lens' DescribeComputeEnvironments (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

describeComputeEnvironments_maxResults :: Lens' DescribeComputeEnvironments (Maybe Int) Source #

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

data DescribeComputeEnvironmentsResponse Source #

Constructors

DescribeComputeEnvironmentsResponse' 

Fields

  • computeEnvironments :: Maybe [ComputeEnvironmentDetail]

    The list of compute environments.

  • nextToken :: Maybe Text

    The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Read DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Show DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

Generic DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

NFData DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironmentsResponse Source # 
Instance details

Defined in Amazonka.Batch.DescribeComputeEnvironments

type Rep DescribeComputeEnvironmentsResponse = D1 ('MetaData "DescribeComputeEnvironmentsResponse" "Amazonka.Batch.DescribeComputeEnvironments" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "DescribeComputeEnvironmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "computeEnvironments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComputeEnvironmentDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeComputeEnvironmentsResponse Source #

Create a value of DescribeComputeEnvironmentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeEnvironments:DescribeComputeEnvironments', describeComputeEnvironmentsResponse_computeEnvironments - The list of compute environments.

$sel:nextToken:DescribeComputeEnvironments', describeComputeEnvironmentsResponse_nextToken - The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeComputeEnvironmentsResponse', describeComputeEnvironmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeComputeEnvironmentsResponse_nextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text) Source #

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.