Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DirectoryService.DescribeUpdateDirectory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the updates of a directory for a particular update type.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeUpdateDirectory Source #

See: newDescribeUpdateDirectory smart constructor.

Constructors

DescribeUpdateDirectory'
Fields nextToken :: Maybe Text The `DescribeUpdateDirectoryResult`. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call. regionName :: Maybe Text The name of the Region. directoryId :: Text The unique identifier of the directory. updateType :: UpdateType The type of updates you want to describe for the directory.

Instances

Instances details

ToJSON DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods toJSON :: DescribeUpdateDirectory -> Value # toEncoding :: DescribeUpdateDirectory -> Encoding # toJSONList :: [DescribeUpdateDirectory] -> Value # toEncodingList :: [DescribeUpdateDirectory] -> Encoding #
ToHeaders DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods toHeaders :: DescribeUpdateDirectory -> [Header] #
ToPath DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods toPath :: DescribeUpdateDirectory -> ByteString #
ToQuery DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods toQuery :: DescribeUpdateDirectory -> QueryString #
AWSPager DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods page :: DescribeUpdateDirectory -> AWSResponse DescribeUpdateDirectory -> Maybe DescribeUpdateDirectory #
AWSRequest DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Associated Types type AWSResponse DescribeUpdateDirectory # Methods request :: (Service -> Service) -> DescribeUpdateDirectory -> Request DescribeUpdateDirectory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUpdateDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUpdateDirectory))) #
Generic DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Associated Types type Rep DescribeUpdateDirectory :: Type -> Type # Methods from :: DescribeUpdateDirectory -> Rep DescribeUpdateDirectory x # to :: Rep DescribeUpdateDirectory x -> DescribeUpdateDirectory #
Read DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods readsPrec :: Int -> ReadS DescribeUpdateDirectory # readList :: ReadS [DescribeUpdateDirectory] # readPrec :: ReadPrec DescribeUpdateDirectory # readListPrec :: ReadPrec [DescribeUpdateDirectory] #
Show DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods showsPrec :: Int -> DescribeUpdateDirectory -> ShowS # show :: DescribeUpdateDirectory -> String # showList :: [DescribeUpdateDirectory] -> ShowS #
NFData DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods rnf :: DescribeUpdateDirectory -> () #
Eq DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods (==) :: DescribeUpdateDirectory -> DescribeUpdateDirectory -> Bool # (/=) :: DescribeUpdateDirectory -> DescribeUpdateDirectory -> Bool #
Hashable DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods hashWithSalt :: Int -> DescribeUpdateDirectory -> Int # hash :: DescribeUpdateDirectory -> Int #
type AWSResponse DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory type AWSResponse DescribeUpdateDirectory = DescribeUpdateDirectoryResponse
type Rep DescribeUpdateDirectory Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory type Rep DescribeUpdateDirectory = D1 ('MetaData "DescribeUpdateDirectory" "Amazonka.DirectoryService.DescribeUpdateDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeUpdateDirectory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UpdateType))))

newDescribeUpdateDirectory Source #

Arguments

:: Text	`DescribeUpdateDirectory`
-> UpdateType	`$sel:updateType:DescribeUpdateDirectory'`
-> DescribeUpdateDirectory

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

DescribeUpdateDirectory, describeUpdateDirectory_nextToken - The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.

DescribeUpdateDirectory, describeUpdateDirectory_regionName - The name of the Region.

DescribeUpdateDirectory, describeUpdateDirectory_directoryId - The unique identifier of the directory.

$sel:updateType:DescribeUpdateDirectory', describeUpdateDirectory_updateType - The type of updates you want to describe for the directory.

Request Lenses

describeUpdateDirectory_nextToken :: Lens' DescribeUpdateDirectory (Maybe Text) Source #

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

describeUpdateDirectory_regionName :: Lens' DescribeUpdateDirectory (Maybe Text) Source #

The name of the Region.

describeUpdateDirectory_directoryId :: Lens' DescribeUpdateDirectory Text Source #

The unique identifier of the directory.

describeUpdateDirectory_updateType :: Lens' DescribeUpdateDirectory UpdateType Source #

The type of updates you want to describe for the directory.

Destructuring the Response

data DescribeUpdateDirectoryResponse Source #

See: newDescribeUpdateDirectoryResponse smart constructor.

Constructors

DescribeUpdateDirectoryResponse'
Fields nextToken :: Maybe Text If not null, more results are available. Pass this value for the `NextToken` parameter. updateActivities :: Maybe [UpdateInfoEntry] The list of update activities on a directory for the requested update type. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Associated Types type Rep DescribeUpdateDirectoryResponse :: Type -> Type # Methods from :: DescribeUpdateDirectoryResponse -> Rep DescribeUpdateDirectoryResponse x # to :: Rep DescribeUpdateDirectoryResponse x -> DescribeUpdateDirectoryResponse #
Read DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods readsPrec :: Int -> ReadS DescribeUpdateDirectoryResponse # readList :: ReadS [DescribeUpdateDirectoryResponse] # readPrec :: ReadPrec DescribeUpdateDirectoryResponse # readListPrec :: ReadPrec [DescribeUpdateDirectoryResponse] #
Show DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods showsPrec :: Int -> DescribeUpdateDirectoryResponse -> ShowS # show :: DescribeUpdateDirectoryResponse -> String # showList :: [DescribeUpdateDirectoryResponse] -> ShowS #
NFData DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods rnf :: DescribeUpdateDirectoryResponse -> () #
Eq DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory Methods (==) :: DescribeUpdateDirectoryResponse -> DescribeUpdateDirectoryResponse -> Bool # (/=) :: DescribeUpdateDirectoryResponse -> DescribeUpdateDirectoryResponse -> Bool #
type Rep DescribeUpdateDirectoryResponse Source #
Instance details Defined in Amazonka.DirectoryService.DescribeUpdateDirectory type Rep DescribeUpdateDirectoryResponse = D1 ('MetaData "DescribeUpdateDirectoryResponse" "Amazonka.DirectoryService.DescribeUpdateDirectory" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "DescribeUpdateDirectoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "updateActivities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpdateInfoEntry])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUpdateDirectoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUpdateDirectoryResponse'`
-> DescribeUpdateDirectoryResponse

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

DescribeUpdateDirectory, describeUpdateDirectoryResponse_nextToken - If not null, more results are available. Pass this value for the NextToken parameter.

$sel:updateActivities:DescribeUpdateDirectoryResponse', describeUpdateDirectoryResponse_updateActivities - The list of update activities on a directory for the requested update type.

$sel:httpStatus:DescribeUpdateDirectoryResponse', describeUpdateDirectoryResponse_httpStatus - The response's http status code.

Response Lenses

describeUpdateDirectoryResponse_nextToken :: Lens' DescribeUpdateDirectoryResponse (Maybe Text) Source #

If not null, more results are available. Pass this value for the NextToken parameter.

describeUpdateDirectoryResponse_updateActivities :: Lens' DescribeUpdateDirectoryResponse (Maybe [UpdateInfoEntry]) Source #

The list of update activities on a directory for the requested update type.

describeUpdateDirectoryResponse_httpStatus :: Lens' DescribeUpdateDirectoryResponse Int Source #

The response's http status code.