ManagedBlockchain / Client / get_member

get_member#

ManagedBlockchain.Client.get_member(**kwargs)#

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.get_member(
    NetworkId='string',
    MemberId='string'
)
Parameters:

  • NetworkId (string) –

    [REQUIRED]

    The unique identifier of the network to which the member belongs.

  • MemberId (string) –

    [REQUIRED]

    The unique identifier of the member.

Return type:

dict

Returns:

Response Syntax

{
    'Member': {
        'NetworkId': 'string',
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'AdminUsername': 'string',
                'CaEndpoint': 'string'
            }
        },
        'LogPublishingConfiguration': {
            'Fabric': {
                'CaLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'INACCESSIBLE_ENCRYPTION_KEY',
        'CreationDate': datetime(2015, 1, 1),
        'Tags': {
            'string': 'string'
        },
        'Arn': 'string',
        'KmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) –

    • Member (dict) –

      The properties of a member.

      • NetworkId (string) –

        The unique identifier of the network to which the member belongs.

      • Id (string) –

        The unique identifier of the member.

      • Name (string) –

        The name of the member.

      • Description (string) –

        An optional description for the member.

      • FrameworkAttributes (dict) –

        Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

        • Fabric (dict) –

          Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.

          • AdminUsername (string) –

            The user name for the initial administrator user for the member.

          • CaEndpoint (string) –

            The endpoint used to access the member’s certificate authority.

      • LogPublishingConfiguration (dict) –

        Configuration properties for logging events associated with a member.

        • Fabric (dict) –

          Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

          • CaLogs (dict) –

            Configuration properties for logging events associated with a member’s Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.

            • Cloudwatch (dict) –

              Parameters for publishing logs to Amazon CloudWatch Logs.

              • Enabled (boolean) –

                Indicates whether logging is enabled.

      • Status (string) –

        The status of a member.

        • CREATING - The Amazon Web Services account is in the process of creating a member.

        • AVAILABLE - The member has been created and can participate in the network.

        • CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.

        • UPDATING - The member is in the process of being updated.

        • DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

        • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

        • INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked. The effect of disabling or deleting a key or of revoking a grant isn’t immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

      • CreationDate (datetime) –

        The date and time that the member was created.

      • Tags (dict) –

        Tags assigned to the member. Tags consist of a key and optional value.

        For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

        • (string) –

          • (string) –

      • Arn (string) –

        The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      • KmsKeyArn (string) –

        The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.

        For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Exceptions