Amazonka.ECS.DescribeCapacityProviders

Describes one or more of your capacity providers.

Creating a Request

data DescribeCapacityProviders

See: newDescribeCapacityProviders smart constructor.

Constructors

DescribeCapacityProviders'

Fields

• capacityProviders :: Maybe [Text]

  The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

• include :: Maybe [CapacityProviderField]

  Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

• maxResults :: Maybe Int

  The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

• nextToken :: Maybe Text

  The nextToken value returned from a previous paginated DescribeCapacityProviders 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Instances

ToJSON DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

toJSON :: DescribeCapacityProviders -> Value

toEncoding :: DescribeCapacityProviders -> Encoding

toJSONList :: [DescribeCapacityProviders] -> Value

toEncodingList :: [DescribeCapacityProviders] -> Encoding

ToHeaders DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

toHeaders :: DescribeCapacityProviders -> [Header]

ToPath DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

toPath :: DescribeCapacityProviders -> ByteString

ToQuery DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

toQuery :: DescribeCapacityProviders -> QueryString

AWSRequest DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Associated Types

type AWSResponse DescribeCapacityProviders

Methods

request :: (Service -> Service) -> DescribeCapacityProviders -> Request DescribeCapacityProviders

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCapacityProviders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCapacityProviders)))

Generic DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Associated Types

type Rep DescribeCapacityProviders :: Type -> Type

Methods

from :: DescribeCapacityProviders -> Rep DescribeCapacityProviders x

to :: Rep DescribeCapacityProviders x -> DescribeCapacityProviders

Read DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

readsPrec :: Int -> ReadS DescribeCapacityProviders

readList :: ReadS [DescribeCapacityProviders]

readPrec :: ReadPrec DescribeCapacityProviders

readListPrec :: ReadPrec [DescribeCapacityProviders]

Show DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

showsPrec :: Int -> DescribeCapacityProviders -> ShowS

show :: DescribeCapacityProviders -> String

showList :: [DescribeCapacityProviders] -> ShowS

NFData DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

rnf :: DescribeCapacityProviders -> ()

Eq DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

(==) :: DescribeCapacityProviders -> DescribeCapacityProviders -> Bool

(/=) :: DescribeCapacityProviders -> DescribeCapacityProviders -> Bool

Hashable DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

hashWithSalt :: Int -> DescribeCapacityProviders -> Int

hash :: DescribeCapacityProviders -> Int

type AWSResponse DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

type AWSResponse DescribeCapacityProviders = DescribeCapacityProvidersResponse

type Rep DescribeCapacityProviders

Defined in Amazonka.ECS.DescribeCapacityProviders

type Rep DescribeCapacityProviders = D1 ('MetaData "DescribeCapacityProviders" "Amazonka.ECS.DescribeCapacityProviders" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DescribeCapacityProviders'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capacityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProviderField]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCapacityProviders :: DescribeCapacityProviders

Create a value of DescribeCapacityProviders 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:

DescribeCapacityProviders, describeCapacityProviders_capacityProviders - The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

$sel:include:DescribeCapacityProviders', describeCapacityProviders_include - Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

$sel:maxResults:DescribeCapacityProviders', describeCapacityProviders_maxResults - The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

DescribeCapacityProviders, describeCapacityProviders_nextToken - The nextToken value returned from a previous paginated DescribeCapacityProviders 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

describeCapacityProviders_capacityProviders :: Lens' DescribeCapacityProviders (Maybe [Text])

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

describeCapacityProviders_include :: Lens' DescribeCapacityProviders (Maybe [CapacityProviderField])

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeCapacityProviders_maxResults :: Lens' DescribeCapacityProviders (Maybe Int)

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders 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 DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

describeCapacityProviders_nextToken :: Lens' DescribeCapacityProviders (Maybe Text)

The nextToken value returned from a previous paginated DescribeCapacityProviders 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data DescribeCapacityProvidersResponse

See: newDescribeCapacityProvidersResponse smart constructor.

Constructors

DescribeCapacityProvidersResponse'

Fields

• capacityProviders :: Maybe [CapacityProvider]

  The list of capacity providers.

• failures :: Maybe [Failure]

  Any failures associated with the call.

• nextToken :: Maybe Text

  The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders 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

Generic DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

Associated Types

type Rep DescribeCapacityProvidersResponse :: Type -> Type

Methods

from :: DescribeCapacityProvidersResponse -> Rep DescribeCapacityProvidersResponse x

to :: Rep DescribeCapacityProvidersResponse x -> DescribeCapacityProvidersResponse

Read DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

readsPrec :: Int -> ReadS DescribeCapacityProvidersResponse

readList :: ReadS [DescribeCapacityProvidersResponse]

readPrec :: ReadPrec DescribeCapacityProvidersResponse

readListPrec :: ReadPrec [DescribeCapacityProvidersResponse]

Show DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

showsPrec :: Int -> DescribeCapacityProvidersResponse -> ShowS

show :: DescribeCapacityProvidersResponse -> String

showList :: [DescribeCapacityProvidersResponse] -> ShowS

NFData DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

rnf :: DescribeCapacityProvidersResponse -> ()

Eq DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

Methods

(==) :: DescribeCapacityProvidersResponse -> DescribeCapacityProvidersResponse -> Bool

(/=) :: DescribeCapacityProvidersResponse -> DescribeCapacityProvidersResponse -> Bool

type Rep DescribeCapacityProvidersResponse

Defined in Amazonka.ECS.DescribeCapacityProviders

type Rep DescribeCapacityProvidersResponse = D1 ('MetaData "DescribeCapacityProvidersResponse" "Amazonka.ECS.DescribeCapacityProviders" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DescribeCapacityProvidersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capacityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CapacityProvider])) :*: S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Failure]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCapacityProvidersResponse

Arguments

:: Int

$sel:httpStatus:DescribeCapacityProvidersResponse'

-> DescribeCapacityProvidersResponse

Create a value of DescribeCapacityProvidersResponse 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:

DescribeCapacityProviders, describeCapacityProvidersResponse_capacityProviders - The list of capacity providers.

$sel:failures:DescribeCapacityProvidersResponse', describeCapacityProvidersResponse_failures - Any failures associated with the call.

DescribeCapacityProviders, describeCapacityProvidersResponse_nextToken - The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders 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:DescribeCapacityProvidersResponse', describeCapacityProvidersResponse_httpStatus - The response's http status code.

Response Lenses

describeCapacityProvidersResponse_capacityProviders :: Lens' DescribeCapacityProvidersResponse (Maybe [CapacityProvider])

The list of capacity providers.

describeCapacityProvidersResponse_failures :: Lens' DescribeCapacityProvidersResponse (Maybe [Failure])

Any failures associated with the call.

describeCapacityProvidersResponse_nextToken :: Lens' DescribeCapacityProvidersResponse (Maybe Text)

The nextToken value to include in a future DescribeCapacityProviders request. When the results of a DescribeCapacityProviders 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.

describeCapacityProvidersResponse_httpStatus :: Lens' DescribeCapacityProvidersResponse Int

The response's http status code.