describeStateMachine method

Future<DescribeStateMachineOutput> describeStateMachine({
  1. required String stateMachineArn,
})

Describes a state machine.

May throw InvalidArn. May throw StateMachineDoesNotExist.

Parameter stateMachineArn : The Amazon Resource Name (ARN) of the state machine to describe.

Implementation

Future<DescribeStateMachineOutput> describeStateMachine({
  required String stateMachineArn,
}) async {
  ArgumentError.checkNotNull(stateMachineArn, 'stateMachineArn');
  _s.validateStringLength(
    'stateMachineArn',
    stateMachineArn,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'AWSStepFunctions.DescribeStateMachine'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'stateMachineArn': stateMachineArn,
    },
  );

  return DescribeStateMachineOutput.fromJson(jsonResponse.body);
}