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.WorkMail.DescribeResource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the data available for the resource.

Synopsis

data DescribeResource = DescribeResource' {
- organizationId :: Text
- resourceId :: Text
}
newDescribeResource :: Text -> Text -> DescribeResource
describeResource_organizationId :: Lens' DescribeResource Text
describeResource_resourceId :: Lens' DescribeResource Text
data DescribeResourceResponse = DescribeResourceResponse' {
- bookingOptions :: Maybe BookingOptions
- disabledDate :: Maybe POSIX
- email :: Maybe Text
- enabledDate :: Maybe POSIX
- name :: Maybe Text
- resourceId :: Maybe Text
- state :: Maybe EntityState
- type' :: Maybe ResourceType
- httpStatus :: Int
}
newDescribeResourceResponse :: Int -> DescribeResourceResponse
describeResourceResponse_bookingOptions :: Lens' DescribeResourceResponse (Maybe BookingOptions)
describeResourceResponse_disabledDate :: Lens' DescribeResourceResponse (Maybe UTCTime)
describeResourceResponse_email :: Lens' DescribeResourceResponse (Maybe Text)
describeResourceResponse_enabledDate :: Lens' DescribeResourceResponse (Maybe UTCTime)
describeResourceResponse_name :: Lens' DescribeResourceResponse (Maybe Text)
describeResourceResponse_resourceId :: Lens' DescribeResourceResponse (Maybe Text)
describeResourceResponse_state :: Lens' DescribeResourceResponse (Maybe EntityState)
describeResourceResponse_type :: Lens' DescribeResourceResponse (Maybe ResourceType)
describeResourceResponse_httpStatus :: Lens' DescribeResourceResponse Int

Creating a Request

data DescribeResource Source #

See: newDescribeResource smart constructor.

Constructors

DescribeResource'
Fields organizationId :: Text The identifier associated with the organization for which the resource is described. resourceId :: Text The identifier of the resource to be described.

Instances

Instances details

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

newDescribeResource Source #

Arguments

:: Text	`DescribeResource`
-> Text	`DescribeResource`
-> DescribeResource

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

DescribeResource, describeResource_organizationId - The identifier associated with the organization for which the resource is described.

DescribeResource, describeResource_resourceId - The identifier of the resource to be described.

Request Lenses

describeResource_organizationId :: Lens' DescribeResource Text Source #

The identifier associated with the organization for which the resource is described.

describeResource_resourceId :: Lens' DescribeResource Text Source #

The identifier of the resource to be described.

Destructuring the Response

data DescribeResourceResponse Source #

See: newDescribeResourceResponse smart constructor.

Constructors

DescribeResourceResponse'

Fields

bookingOptions :: Maybe BookingOptions
The booking options for the described resource.
disabledDate :: Maybe POSIX
The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
email :: Maybe Text
The email of the described resource.
enabledDate :: Maybe POSIX
The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
name :: Maybe Text
The name of the described resource.
resourceId :: Maybe Text
The identifier of the described resource.
state :: Maybe EntityState
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
type' :: Maybe ResourceType
The type of the described resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource Associated Types type Rep DescribeResourceResponse :: Type -> Type # Methods from :: DescribeResourceResponse -> Rep DescribeResourceResponse x # to :: Rep DescribeResourceResponse x -> DescribeResourceResponse #
Read DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource Methods readsPrec :: Int -> ReadS DescribeResourceResponse # readList :: ReadS [DescribeResourceResponse] # readPrec :: ReadPrec DescribeResourceResponse # readListPrec :: ReadPrec [DescribeResourceResponse] #
Show DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource Methods showsPrec :: Int -> DescribeResourceResponse -> ShowS # show :: DescribeResourceResponse -> String # showList :: [DescribeResourceResponse] -> ShowS #
NFData DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource Methods rnf :: DescribeResourceResponse -> () #
Eq DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource Methods (==) :: DescribeResourceResponse -> DescribeResourceResponse -> Bool # (/=) :: DescribeResourceResponse -> DescribeResourceResponse -> Bool #
type Rep DescribeResourceResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeResource type Rep DescribeResourceResponse = D1 ('MetaData "DescribeResourceResponse" "Amazonka.WorkMail.DescribeResource" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DescribeResourceResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bookingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BookingOptions)) :: S1 ('MetaSel ('Just "disabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityState)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeResourceResponse Source #

Arguments

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

Create a value of DescribeResourceResponse 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:bookingOptions:DescribeResourceResponse', describeResourceResponse_bookingOptions - The booking options for the described resource.

DescribeResourceResponse, describeResourceResponse_disabledDate - The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

DescribeResourceResponse, describeResourceResponse_email - The email of the described resource.

DescribeResourceResponse, describeResourceResponse_enabledDate - The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

DescribeResourceResponse, describeResourceResponse_name - The name of the described resource.

DescribeResource, describeResourceResponse_resourceId - The identifier of the described resource.

DescribeResourceResponse, describeResourceResponse_state - The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

DescribeResourceResponse, describeResourceResponse_type - The type of the described resource.

$sel:httpStatus:DescribeResourceResponse', describeResourceResponse_httpStatus - The response's http status code.

Response Lenses

describeResourceResponse_bookingOptions :: Lens' DescribeResourceResponse (Maybe BookingOptions) Source #

The booking options for the described resource.

describeResourceResponse_disabledDate :: Lens' DescribeResourceResponse (Maybe UTCTime) Source #

The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

describeResourceResponse_email :: Lens' DescribeResourceResponse (Maybe Text) Source #

The email of the described resource.

describeResourceResponse_enabledDate :: Lens' DescribeResourceResponse (Maybe UTCTime) Source #

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

describeResourceResponse_name :: Lens' DescribeResourceResponse (Maybe Text) Source #

The name of the described resource.

describeResourceResponse_resourceId :: Lens' DescribeResourceResponse (Maybe Text) Source #

The identifier of the described resource.

describeResourceResponse_state :: Lens' DescribeResourceResponse (Maybe EntityState) Source #

The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

describeResourceResponse_type :: Lens' DescribeResourceResponse (Maybe ResourceType) Source #

The type of the described resource.

describeResourceResponse_httpStatus :: Lens' DescribeResourceResponse Int Source #

The response's http status code.