| 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.Connect.CreateTrafficDistributionGroup
Description
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
Synopsis
- data CreateTrafficDistributionGroup = CreateTrafficDistributionGroup' {
- clientToken :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- instanceId :: Text
- newCreateTrafficDistributionGroup :: Text -> Text -> CreateTrafficDistributionGroup
- createTrafficDistributionGroup_clientToken :: Lens' CreateTrafficDistributionGroup (Maybe Text)
- createTrafficDistributionGroup_description :: Lens' CreateTrafficDistributionGroup (Maybe Text)
- createTrafficDistributionGroup_tags :: Lens' CreateTrafficDistributionGroup (Maybe (HashMap Text Text))
- createTrafficDistributionGroup_name :: Lens' CreateTrafficDistributionGroup Text
- createTrafficDistributionGroup_instanceId :: Lens' CreateTrafficDistributionGroup Text
- data CreateTrafficDistributionGroupResponse = CreateTrafficDistributionGroupResponse' {}
- newCreateTrafficDistributionGroupResponse :: Int -> CreateTrafficDistributionGroupResponse
- createTrafficDistributionGroupResponse_arn :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text)
- createTrafficDistributionGroupResponse_id :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text)
- createTrafficDistributionGroupResponse_httpStatus :: Lens' CreateTrafficDistributionGroupResponse Int
Creating a Request
data CreateTrafficDistributionGroup Source #
See: newCreateTrafficDistributionGroup smart constructor.
Constructors
| CreateTrafficDistributionGroup' | |
Fields
| |
Instances
newCreateTrafficDistributionGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateTrafficDistributionGroup |
Create a value of CreateTrafficDistributionGroup 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:clientToken:CreateTrafficDistributionGroup', createTrafficDistributionGroup_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If not provided, the Amazon Web Services SDK
populates this field. For more information about idempotency, see
Making retries safe with idempotent APIs.
CreateTrafficDistributionGroup, createTrafficDistributionGroup_description - A description for the traffic distribution group.
CreateTrafficDistributionGroup, createTrafficDistributionGroup_tags - The tags used to organize, track, or control access for this resource.
For example, { "tags": {"key1":"value1", "key2":"value2"} }.
CreateTrafficDistributionGroup, createTrafficDistributionGroup_name - The name for the traffic distribution group.
CreateTrafficDistributionGroup, createTrafficDistributionGroup_instanceId - The identifier of the Amazon Connect instance that has been replicated.
You can find the instanceId in the ARN of the instance.
Request Lenses
createTrafficDistributionGroup_clientToken :: Lens' CreateTrafficDistributionGroup (Maybe Text) Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
createTrafficDistributionGroup_description :: Lens' CreateTrafficDistributionGroup (Maybe Text) Source #
A description for the traffic distribution group.
createTrafficDistributionGroup_tags :: Lens' CreateTrafficDistributionGroup (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
createTrafficDistributionGroup_name :: Lens' CreateTrafficDistributionGroup Text Source #
The name for the traffic distribution group.
createTrafficDistributionGroup_instanceId :: Lens' CreateTrafficDistributionGroup Text Source #
The identifier of the Amazon Connect instance that has been replicated.
You can find the instanceId in the ARN of the instance.
Destructuring the Response
data CreateTrafficDistributionGroupResponse Source #
See: newCreateTrafficDistributionGroupResponse smart constructor.
Constructors
| CreateTrafficDistributionGroupResponse' | |
Fields
| |
Instances
newCreateTrafficDistributionGroupResponse Source #
Arguments
| :: Int | |
| -> CreateTrafficDistributionGroupResponse |
Create a value of CreateTrafficDistributionGroupResponse 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:
CreateTrafficDistributionGroupResponse, createTrafficDistributionGroupResponse_arn - The Amazon Resource Name (ARN) of the traffic distribution group.
CreateTrafficDistributionGroupResponse, createTrafficDistributionGroupResponse_id - The identifier of the traffic distribution group. This can be the ID or
the ARN if the API is being called in the Region where the traffic
distribution group was created. The ARN must be provided if the call is
from the replicated Region.
$sel:httpStatus:CreateTrafficDistributionGroupResponse', createTrafficDistributionGroupResponse_httpStatus - The response's http status code.
Response Lenses
createTrafficDistributionGroupResponse_arn :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the traffic distribution group.
createTrafficDistributionGroupResponse_id :: Lens' CreateTrafficDistributionGroupResponse (Maybe Text) Source #
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.
createTrafficDistributionGroupResponse_httpStatus :: Lens' CreateTrafficDistributionGroupResponse Int Source #
The response's http status code.