ManagedintegrationsforIoTDeviceManagement / Client / create_account_association

create_account_association

ManagedintegrationsforIoTDeviceManagement.Client.create_account_association(**kwargs)

Creates a new account association via the destination id.

See also: AWS API Documentation

Request Syntax

response = client.create_account_association(
    ClientToken='string',
    ConnectorDestinationId='string',
    Name='string',
    Description='string',
    Tags={
        'string': 'string'
    },
    GeneralAuthorization={
        'AuthMaterialName': 'string'
    }
)
Parameters:

  • ClientToken (string) –

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    This field is autopopulated if not provided.

  • ConnectorDestinationId (string) –

    [REQUIRED]

    The identifier of the connector destination.

  • Name (string) – The name of the destination for the new account association.

  • Description (string) – A description of the account association request.

  • Tags (dict) –

    A set of key/value pairs that are used to manage the account association.

    • (string) –

      • (string) –

  • GeneralAuthorization (dict) –

    The General Authorization reference by authorization material name.

    • AuthMaterialName (string) –

      The name of the authorization material.

Return type:

dict

Returns:

Response Syntax

{
    'OAuthAuthorizationUrl': 'string',
    'AccountAssociationId': 'string',
    'AssociationState': 'ASSOCIATION_IN_PROGRESS'|'ASSOCIATION_FAILED'|'ASSOCIATION_SUCCEEDED'|'ASSOCIATION_DELETING'|'REFRESH_TOKEN_EXPIRED',
    'Arn': 'string'
}

Response Structure

  • (dict) –

    • OAuthAuthorizationUrl (string) –

      Third-party IoT platform OAuth authorization server URL backed with all the required parameters to perform end-user authentication. This field will be empty when using General Authorization flows that do not require OAuth.

    • AccountAssociationId (string) –

      The identifier for the account association request.

    • AssociationState (string) –

      The current state of the account association request.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the account association.

Exceptions