Amazonka.DirectoryService.DescribeSettings

Retrieves information about the configurable settings for the specified directory.

Creating a Request

data DescribeSettings

See: newDescribeSettings smart constructor.

Constructors

DescribeSettings'

Fields

• nextToken :: Maybe Text

  The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

• status :: Maybe DirectoryConfigurationStatus

  The status of the directory settings for which to retrieve information.

• directoryId :: Text

  The identifier of the directory for which to retrieve information.

Instances

ToJSON DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

toJSON :: DescribeSettings -> Value

toEncoding :: DescribeSettings -> Encoding

toJSONList :: [DescribeSettings] -> Value

toEncodingList :: [DescribeSettings] -> Encoding

ToHeaders DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

toHeaders :: DescribeSettings -> [Header]

ToPath DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

toPath :: DescribeSettings -> ByteString

ToQuery DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

toQuery :: DescribeSettings -> QueryString

AWSRequest DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Associated Types

type AWSResponse DescribeSettings

Methods

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

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

Generic DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Associated Types

type Rep DescribeSettings :: Type -> Type

Methods

from :: DescribeSettings -> Rep DescribeSettings x

to :: Rep DescribeSettings x -> DescribeSettings

Read DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

readsPrec :: Int -> ReadS DescribeSettings

readList :: ReadS [DescribeSettings]

readPrec :: ReadPrec DescribeSettings

readListPrec :: ReadPrec [DescribeSettings]

Show DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

showsPrec :: Int -> DescribeSettings -> ShowS

show :: DescribeSettings -> String

showList :: [DescribeSettings] -> ShowS

NFData DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

rnf :: DescribeSettings -> ()

Eq DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

(==) :: DescribeSettings -> DescribeSettings -> Bool

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

Hashable DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

hashWithSalt :: Int -> DescribeSettings -> Int

hash :: DescribeSettings -> Int

type AWSResponse DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

type AWSResponse DescribeSettings = DescribeSettingsResponse

type Rep DescribeSettings

Defined in Amazonka.DirectoryService.DescribeSettings

type Rep DescribeSettings = D1 ('MetaData "DescribeSettings" "Amazonka.DirectoryService.DescribeSettings" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryConfigurationStatus)) :*: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeSettings

Arguments

:: Text

DescribeSettings

-> DescribeSettings

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

DescribeSettings, describeSettings_nextToken - The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

DescribeSettings, describeSettings_status - The status of the directory settings for which to retrieve information.

DescribeSettings, describeSettings_directoryId - The identifier of the directory for which to retrieve information.

Request Lenses

describeSettings_nextToken :: Lens' DescribeSettings (Maybe Text)

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

describeSettings_status :: Lens' DescribeSettings (Maybe DirectoryConfigurationStatus)

The status of the directory settings for which to retrieve information.

describeSettings_directoryId :: Lens' DescribeSettings Text

The identifier of the directory for which to retrieve information.

Destructuring the Response

data DescribeSettingsResponse

See: newDescribeSettingsResponse smart constructor.

Constructors

DescribeSettingsResponse'

Fields

• directoryId :: Maybe Text

  The identifier of the directory.

• nextToken :: Maybe Text

  If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

• settingEntries :: Maybe [SettingEntry]

  The list of SettingEntry objects that were retrieved.

  It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

Associated Types

type Rep DescribeSettingsResponse :: Type -> Type

Methods

from :: DescribeSettingsResponse -> Rep DescribeSettingsResponse x

to :: Rep DescribeSettingsResponse x -> DescribeSettingsResponse

Read DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

readsPrec :: Int -> ReadS DescribeSettingsResponse

readList :: ReadS [DescribeSettingsResponse]

readPrec :: ReadPrec DescribeSettingsResponse

readListPrec :: ReadPrec [DescribeSettingsResponse]

Show DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

showsPrec :: Int -> DescribeSettingsResponse -> ShowS

show :: DescribeSettingsResponse -> String

showList :: [DescribeSettingsResponse] -> ShowS

NFData DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

rnf :: DescribeSettingsResponse -> ()

Eq DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

Methods

(==) :: DescribeSettingsResponse -> DescribeSettingsResponse -> Bool

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

type Rep DescribeSettingsResponse

Defined in Amazonka.DirectoryService.DescribeSettings

type Rep DescribeSettingsResponse = D1 ('MetaData "DescribeSettingsResponse" "Amazonka.DirectoryService.DescribeSettings" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeSettingsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "settingEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SettingEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSettingsResponse

Arguments

:: Int

$sel:httpStatus:DescribeSettingsResponse'

-> DescribeSettingsResponse

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

DescribeSettings, describeSettingsResponse_directoryId - The identifier of the directory.

DescribeSettings, describeSettingsResponse_nextToken - If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

$sel:settingEntries:DescribeSettingsResponse', describeSettingsResponse_settingEntries - The list of SettingEntry objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

$sel:httpStatus:DescribeSettingsResponse', describeSettingsResponse_httpStatus - The response's http status code.

Response Lenses

describeSettingsResponse_directoryId :: Lens' DescribeSettingsResponse (Maybe Text)

The identifier of the directory.

describeSettingsResponse_nextToken :: Lens' DescribeSettingsResponse (Maybe Text)

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

describeSettingsResponse_settingEntries :: Lens' DescribeSettingsResponse (Maybe [SettingEntry])

The list of SettingEntry objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

describeSettingsResponse_httpStatus :: Lens' DescribeSettingsResponse Int

The response's http status code.