Unbox class - Amazon Glue
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Unbox class

Unboxes (reformats) a string field in a DynamicFrame.

Example

We recommend that you use the DynamicFrame.unbox() method to unbox a field in a DynamicFrame. To view a code example, see Example: Use unbox to unbox a string field into a struct.

Methods

__call__(frame, path, format, transformation_ctx = "", info="", stageThreshold=0, totalThreshold=0, **options)

Unboxes a string field in a DynamicFrame.

  • frame – The DynamicFrame in which to unbox a field. (required).

  • path – The full path to the StringNode to unbox (required).

  • format – A format specification (optional). This is used for an Amazon S3 or Amazon Glue connection that supports multiple formats. For the formats that are supported, see Data format options for inputs and outputs in Amazon Glue.

  • transformation_ctx – A unique string that is used to identify state information (optional).

  • info – A string associated with errors in the transformation (optional).

  • stageThreshold – The maximum number of errors that can occur in the transformation before it errors out (optional). The default is zero.

  • totalThreshold – The maximum number of errors that can occur overall before processing errors out (optional). The default is zero.

  • separator – A separator token (optional).

  • escaper – An escape token (optional).

  • skipFirstTrue if the first line of data should be skipped, or False if it should not be skipped (optional).

  • withSchema – A string that contains a schema for the data to be unboxed (optional). This should always be created using StructType.json.

  • withHeaderTrue if the data being unpacked includes a header, or False if not (optional).

apply(cls, *args, **kwargs)

Inherited from GlueTransform Apply.

name(cls)

Inherited from GlueTransform Name.

describeArgs(cls)

Inherited from GlueTransform describeArgs.

describeReturn(cls)

Inherited from GlueTransform describeReturn.

describeTransform(cls)

Inherited from GlueTransform describeTransform.

describeErrors(cls)

Inherited from GlueTransform describeErrors.

describe(cls)

Inherited from GlueTransform Describe.