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.QuickSight.DescribeGroup
Description
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
Synopsis
- data DescribeGroup = DescribeGroup' {}
- newDescribeGroup :: Text -> Text -> Text -> DescribeGroup
- describeGroup_groupName :: Lens' DescribeGroup Text
- describeGroup_awsAccountId :: Lens' DescribeGroup Text
- describeGroup_namespace :: Lens' DescribeGroup Text
- data DescribeGroupResponse = DescribeGroupResponse' {}
- newDescribeGroupResponse :: Int -> DescribeGroupResponse
- describeGroupResponse_group :: Lens' DescribeGroupResponse (Maybe Group)
- describeGroupResponse_requestId :: Lens' DescribeGroupResponse (Maybe Text)
- describeGroupResponse_status :: Lens' DescribeGroupResponse Int
Creating a Request
data DescribeGroup Source #
See: newDescribeGroup
smart constructor.
Constructors
DescribeGroup' | |
Fields
|
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DescribeGroup |
Create a value of DescribeGroup
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:
DescribeGroup
, describeGroup_groupName
- The name of the group that you want to describe.
DescribeGroup
, describeGroup_awsAccountId
- The ID for the Amazon Web Services account that the group is in.
Currently, you use the ID for the Amazon Web Services account that
contains your Amazon QuickSight account.
DescribeGroup
, describeGroup_namespace
- The namespace of the group that you want described.
Request Lenses
describeGroup_groupName :: Lens' DescribeGroup Text Source #
The name of the group that you want to describe.
describeGroup_awsAccountId :: Lens' DescribeGroup Text Source #
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
describeGroup_namespace :: Lens' DescribeGroup Text Source #
The namespace of the group that you want described.
Destructuring the Response
data DescribeGroupResponse Source #
See: newDescribeGroupResponse
smart constructor.
Constructors
DescribeGroupResponse' | |
Instances
newDescribeGroupResponse Source #
Arguments
:: Int | |
-> DescribeGroupResponse |
Create a value of DescribeGroupResponse
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:group':DescribeGroupResponse'
, describeGroupResponse_group
- The name of the group.
$sel:requestId:DescribeGroupResponse'
, describeGroupResponse_requestId
- The Amazon Web Services request ID for this operation.
DescribeGroupResponse
, describeGroupResponse_status
- The HTTP status of the request.
Response Lenses
describeGroupResponse_group :: Lens' DescribeGroupResponse (Maybe Group) Source #
The name of the group.
describeGroupResponse_requestId :: Lens' DescribeGroupResponse (Maybe Text) Source #
The Amazon Web Services request ID for this operation.
describeGroupResponse_status :: Lens' DescribeGroupResponse Int Source #
The HTTP status of the request.