| 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.PinpointSmsVoiceV2.AssociateOriginationIdentity
Description
Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an Error is returned.
Synopsis
- data AssociateOriginationIdentity = AssociateOriginationIdentity' {}
- newAssociateOriginationIdentity :: Text -> Text -> Text -> AssociateOriginationIdentity
- associateOriginationIdentity_clientToken :: Lens' AssociateOriginationIdentity (Maybe Text)
- associateOriginationIdentity_poolId :: Lens' AssociateOriginationIdentity Text
- associateOriginationIdentity_originationIdentity :: Lens' AssociateOriginationIdentity Text
- associateOriginationIdentity_isoCountryCode :: Lens' AssociateOriginationIdentity Text
- data AssociateOriginationIdentityResponse = AssociateOriginationIdentityResponse' {}
- newAssociateOriginationIdentityResponse :: Int -> AssociateOriginationIdentityResponse
- associateOriginationIdentityResponse_isoCountryCode :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_originationIdentity :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_originationIdentityArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_poolArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_poolId :: Lens' AssociateOriginationIdentityResponse (Maybe Text)
- associateOriginationIdentityResponse_httpStatus :: Lens' AssociateOriginationIdentityResponse Int
Creating a Request
data AssociateOriginationIdentity Source #
See: newAssociateOriginationIdentity smart constructor.
Constructors
| AssociateOriginationIdentity' | |
Fields
| |
Instances
newAssociateOriginationIdentity Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AssociateOriginationIdentity |
Create a value of AssociateOriginationIdentity 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:AssociateOriginationIdentity', associateOriginationIdentity_clientToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
AssociateOriginationIdentity, associateOriginationIdentity_poolId - The pool to update with the new Identity. This value can be either the
PoolId or PoolArn, and you can find these values using DescribePools.
AssociateOriginationIdentity, associateOriginationIdentity_originationIdentity - The origination identity to use, such as PhoneNumberId, PhoneNumberArn,
SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can
be used to get the values for SenderId and SenderIdArn.
AssociateOriginationIdentity, associateOriginationIdentity_isoCountryCode - The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the origination identity.
Request Lenses
associateOriginationIdentity_clientToken :: Lens' AssociateOriginationIdentity (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
associateOriginationIdentity_poolId :: Lens' AssociateOriginationIdentity Text Source #
The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
associateOriginationIdentity_originationIdentity :: Lens' AssociateOriginationIdentity Text Source #
The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
associateOriginationIdentity_isoCountryCode :: Lens' AssociateOriginationIdentity Text Source #
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
Destructuring the Response
data AssociateOriginationIdentityResponse Source #
See: newAssociateOriginationIdentityResponse smart constructor.
Constructors
| AssociateOriginationIdentityResponse' | |
Fields
| |
Instances
newAssociateOriginationIdentityResponse Source #
Arguments
| :: Int | |
| -> AssociateOriginationIdentityResponse |
Create a value of AssociateOriginationIdentityResponse 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:
AssociateOriginationIdentity, associateOriginationIdentityResponse_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
AssociateOriginationIdentity, associateOriginationIdentityResponse_originationIdentity - The PhoneNumberId or SenderId of the origination identity.
AssociateOriginationIdentityResponse, associateOriginationIdentityResponse_originationIdentityArn - The PhoneNumberArn or SenderIdArn of the origination identity.
AssociateOriginationIdentityResponse, associateOriginationIdentityResponse_poolArn - The Amazon Resource Name (ARN) of the pool that is now associated with
the origination identity.
AssociateOriginationIdentity, associateOriginationIdentityResponse_poolId - The PoolId of the pool that is now associated with the origination
identity.
$sel:httpStatus:AssociateOriginationIdentityResponse', associateOriginationIdentityResponse_httpStatus - The response's http status code.
Response Lenses
associateOriginationIdentityResponse_isoCountryCode :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
associateOriginationIdentityResponse_originationIdentity :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberId or SenderId of the origination identity.
associateOriginationIdentityResponse_originationIdentityArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PhoneNumberArn or SenderIdArn of the origination identity.
associateOriginationIdentityResponse_poolArn :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
associateOriginationIdentityResponse_poolId :: Lens' AssociateOriginationIdentityResponse (Maybe Text) Source #
The PoolId of the pool that is now associated with the origination identity.
associateOriginationIdentityResponse_httpStatus :: Lens' AssociateOriginationIdentityResponse Int Source #
The response's http status code.