amazonka-apprunner-2.0: Amazon App Runner SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppRunner.ListObservabilityConfigurations

Description

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.

To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.

Synopsis

Creating a Request

data ListObservabilityConfigurations Source #

See: newListObservabilityConfigurations smart constructor.

Constructors

ListObservabilityConfigurations' 

Fields

  • latestOnly :: Maybe Bool

    Set to true to list only the latest revision for each requested configuration name.

    Set to false to list all revisions for each requested configuration name.

    Default: true

  • maxResults :: Maybe Natural

    The maximum number of results to include in each response (result page). It's used for a paginated request.

    If you don't specify MaxResults, the request retrieves all available results in a single response.

  • nextToken :: Maybe Text

    A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

    If you don't specify NextToken, the request retrieves the first result page.

  • observabilityConfigurationName :: Maybe Text

    The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Instances

Instances details
ToJSON ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

ToHeaders ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

ToPath ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

ToQuery ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

AWSRequest ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Generic ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Associated Types

type Rep ListObservabilityConfigurations :: Type -> Type #

Read ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Show ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

NFData ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Eq ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Hashable ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

type AWSResponse ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

type Rep ListObservabilityConfigurations Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

type Rep ListObservabilityConfigurations = D1 ('MetaData "ListObservabilityConfigurations" "Amazonka.AppRunner.ListObservabilityConfigurations" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "ListObservabilityConfigurations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "latestOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "observabilityConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListObservabilityConfigurations :: ListObservabilityConfigurations Source #

Create a value of ListObservabilityConfigurations 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:latestOnly:ListObservabilityConfigurations', listObservabilityConfigurations_latestOnly - Set to true to list only the latest revision for each requested configuration name.

Set to false to list all revisions for each requested configuration name.

Default: true

$sel:maxResults:ListObservabilityConfigurations', listObservabilityConfigurations_maxResults - The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

ListObservabilityConfigurations, listObservabilityConfigurations_nextToken - A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

ListObservabilityConfigurations, listObservabilityConfigurations_observabilityConfigurationName - The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Request Lenses

listObservabilityConfigurations_latestOnly :: Lens' ListObservabilityConfigurations (Maybe Bool) Source #

Set to true to list only the latest revision for each requested configuration name.

Set to false to list all revisions for each requested configuration name.

Default: true

listObservabilityConfigurations_maxResults :: Lens' ListObservabilityConfigurations (Maybe Natural) Source #

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

listObservabilityConfigurations_nextToken :: Lens' ListObservabilityConfigurations (Maybe Text) Source #

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

listObservabilityConfigurations_observabilityConfigurationName :: Lens' ListObservabilityConfigurations (Maybe Text) Source #

The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Destructuring the Response

data ListObservabilityConfigurationsResponse Source #

Constructors

ListObservabilityConfigurationsResponse' 

Fields

Instances

Instances details
Generic ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Read ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Show ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

NFData ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

Eq ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

type Rep ListObservabilityConfigurationsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.ListObservabilityConfigurations

type Rep ListObservabilityConfigurationsResponse = D1 ('MetaData "ListObservabilityConfigurationsResponse" "Amazonka.AppRunner.ListObservabilityConfigurations" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "ListObservabilityConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "observabilityConfigurationSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ObservabilityConfigurationSummary]))))

newListObservabilityConfigurationsResponse Source #

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

ListObservabilityConfigurations, listObservabilityConfigurationsResponse_nextToken - The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

$sel:httpStatus:ListObservabilityConfigurationsResponse', listObservabilityConfigurationsResponse_httpStatus - The response's http status code.

$sel:observabilityConfigurationSummaryList:ListObservabilityConfigurationsResponse', listObservabilityConfigurationsResponse_observabilityConfigurationSummaryList - A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults records for each call.

Response Lenses

listObservabilityConfigurationsResponse_nextToken :: Lens' ListObservabilityConfigurationsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

listObservabilityConfigurationsResponse_observabilityConfigurationSummaryList :: Lens' ListObservabilityConfigurationsResponse [ObservabilityConfigurationSummary] Source #

A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults records for each call.