AppFabric / Client / get_ingestion_destination

get_ingestion_destination#

AppFabric.Client.get_ingestion_destination(**kwargs)#

Returns information about an ingestion destination.

See also: AWS API Documentation

Request Syntax

response = client.get_ingestion_destination(
    appBundleIdentifier='string',
    ingestionIdentifier='string',
    ingestionDestinationIdentifier='string'
)
Parameters:

  • appBundleIdentifier (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.

  • ingestionIdentifier (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • ingestionDestinationIdentifier (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.

Return type:

dict

Returns:

Response Syntax

{
    'ingestionDestination': {
        'arn': 'string',
        'ingestionArn': 'string',
        'processingConfiguration': {
            'auditLog': {
                'schema': 'ocsf'|'raw',
                'format': 'json'|'parquet'
            }
        },
        'destinationConfiguration': {
            'auditLog': {
                'destination': {
                    's3Bucket': {
                        'bucketName': 'string',
                        'prefix': 'string'
                    },
                    'firehoseStream': {
                        'streamName': 'string'
                    }
                }
            }
        },
        'status': 'Active'|'Failed',
        'statusReason': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • ingestionDestination (dict) –

      Contains information about an ingestion destination.

      • arn (string) –

        The Amazon Resource Name (ARN) of the ingestion destination.

      • ingestionArn (string) –

        The Amazon Resource Name (ARN) of the ingestion.

      • processingConfiguration (dict) –

        Contains information about how ingested data is processed.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: auditLog. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • auditLog (dict) –

          Contains information about an audit log processing configuration.

          • schema (string) –

            The event schema in which the audit logs need to be formatted.

          • format (string) –

            The format in which the audit logs need to be formatted.

      • destinationConfiguration (dict) –

        Contains information about the destination of ingested data.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: auditLog. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • auditLog (dict) –

          Contains information about an audit log destination configuration.

          • destination (dict) –

            Contains information about an audit log destination.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: s3Bucket, firehoseStream. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • s3Bucket (dict) –

              Contains information about an Amazon S3 bucket.

              • bucketName (string) –

                The name of the Amazon S3 bucket.

              • prefix (string) –

                The object key to use.

            • firehoseStream (dict) –

              Contains information about an Amazon Kinesis Data Firehose delivery stream.

              • streamName (string) –

                The name of the Amazon Kinesis Data Firehose delivery stream.

      • status (string) –

        The state of the ingestion destination.

        The following states are possible:

        • Active: The ingestion destination is active and is ready to be used.

        • Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.

      • statusReason (string) –

        The reason for the current status of the ingestion destination.

        Only present when the status of ingestion destination is Failed.

      • createdAt (datetime) –

        The timestamp of when the ingestion destination was created.

      • updatedAt (datetime) –

        The timestamp of when the ingestion destination was last updated.

Exceptions